diff --git a/.ci/Jenkinsfile_flaky b/.ci/Jenkinsfile_flaky index 7eafc66465bc7..8121405e5ae24 100644 --- a/.ci/Jenkinsfile_flaky +++ b/.ci/Jenkinsfile_flaky @@ -73,11 +73,7 @@ def agentProcess(Map params = [:]) { ]) { task { if (config.needBuild) { - if (!config.isXpack) { - kibanaPipeline.buildOss() - } else { - kibanaPipeline.buildXpack() - } + kibanaPipeline.buildKibana() } for(def i = 0; i < config.agentExecutions; i++) { diff --git a/.ci/Jenkinsfile_security_cypress b/.ci/Jenkinsfile_security_cypress index 811af44d1ca56..d48b9965919dc 100644 --- a/.ci/Jenkinsfile_security_cypress +++ b/.ci/Jenkinsfile_security_cypress @@ -16,7 +16,7 @@ kibanaPipeline(timeoutMinutes: 180) { def job = 'xpack-securityCypress' workers.ci(name: job, size: 'l', ramDisk: true) { - kibanaPipeline.bash('test/scripts/jenkins_xpack_build_kibana.sh', 'Build Default Distributable') + kibanaPipeline.bash('test/scripts/jenkins_build_kibana.sh', 'Build Distributable') kibanaPipeline.functionalTestProcess(job, 'test/scripts/jenkins_security_solution_cypress_chrome.sh')() // Temporarily disabled to figure out test flake // kibanaPipeline.functionalTestProcess(job, 'test/scripts/jenkins_security_solution_cypress_firefox.sh')() diff --git a/.ci/es-snapshots/Jenkinsfile_verify_es b/.ci/es-snapshots/Jenkinsfile_verify_es index b22406e389276..dc3a3cde7d658 100644 --- a/.ci/es-snapshots/Jenkinsfile_verify_es +++ b/.ci/es-snapshots/Jenkinsfile_verify_es @@ -37,13 +37,10 @@ kibanaPipeline(timeoutMinutes: 210) { ]) task { - kibanaPipeline.buildOss(6) + kibanaPipeline.buildKibana(16) tasks.ossCiGroups() - } - - task { - kibanaPipeline.buildXpack(10) tasks.xpackCiGroups() + tasks.xpackCiGroupDocker() } } } diff --git a/.ci/jobs.yml b/.ci/jobs.yml index 6aa93d4a1056a..1440c6870a86d 100644 --- a/.ci/jobs.yml +++ b/.ci/jobs.yml @@ -33,6 +33,7 @@ JOB: - x-pack-ciGroup11 - x-pack-ciGroup12 - x-pack-ciGroup13 + - x-pack-ciGroupDocker - x-pack-accessibility - x-pack-visualRegression diff --git a/.eslintrc.js b/.eslintrc.js index 19ba7cacc3c44..20875a2c2913d 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1114,6 +1114,118 @@ module.exports = { 'prefer-destructuring': 'error', }, }, + /** + * Metrics entities overrides + */ + { + // front end and common typescript and javascript files only + files: [ + 'x-pack/plugins/metrics_entities/public/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/metrics_entities/common/**/*.{js,mjs,ts,tsx}', + ], + rules: { + 'import/no-nodejs-modules': 'error', + 'no-restricted-imports': [ + 'error', + { + // prevents UI code from importing server side code and then webpack including it when doing builds + patterns: ['**/server/*'], + }, + ], + }, + }, + { + // typescript and javascript for front and back end + files: ['x-pack/plugins/metrics_entities/**/*.{js,mjs,ts,tsx}'], + plugins: ['eslint-plugin-node'], + env: { + jest: true, + }, + rules: { + 'accessor-pairs': 'error', + 'array-callback-return': 'error', + 'no-array-constructor': 'error', + complexity: 'error', + 'consistent-return': 'error', + 'func-style': ['error', 'expression'], + 'import/order': [ + 'error', + { + groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'], + 'newlines-between': 'always', + }, + ], + 'sort-imports': [ + 'error', + { + ignoreDeclarationSort: true, + }, + ], + 'node/no-deprecated-api': 'error', + 'no-bitwise': 'error', + 'no-continue': 'error', + 'no-dupe-keys': 'error', + 'no-duplicate-case': 'error', + 'no-duplicate-imports': 'error', + 'no-empty-character-class': 'error', + 'no-empty-pattern': 'error', + 'no-ex-assign': 'error', + 'no-extend-native': 'error', + 'no-extra-bind': 'error', + 'no-extra-boolean-cast': 'error', + 'no-extra-label': 'error', + 'no-func-assign': 'error', + 'no-implicit-globals': 'error', + 'no-implied-eval': 'error', + 'no-invalid-regexp': 'error', + 'no-inner-declarations': 'error', + 'no-lone-blocks': 'error', + 'no-multi-assign': 'error', + 'no-misleading-character-class': 'error', + 'no-new-symbol': 'error', + 'no-obj-calls': 'error', + 'no-param-reassign': ['error', { props: true }], + 'no-process-exit': 'error', + 'no-prototype-builtins': 'error', + 'no-return-await': 'error', + 'no-self-compare': 'error', + 'no-shadow-restricted-names': 'error', + 'no-sparse-arrays': 'error', + 'no-this-before-super': 'error', + // rely on typescript + 'no-undef': 'off', + 'no-unreachable': 'error', + 'no-unsafe-finally': 'error', + 'no-useless-call': 'error', + 'no-useless-catch': 'error', + 'no-useless-concat': 'error', + 'no-useless-computed-key': 'error', + 'no-useless-escape': 'error', + 'no-useless-rename': 'error', + 'no-useless-return': 'error', + 'no-void': 'error', + 'one-var-declaration-per-line': 'error', + 'prefer-object-spread': 'error', + 'prefer-promise-reject-errors': 'error', + 'prefer-rest-params': 'error', + 'prefer-spread': 'error', + 'prefer-template': 'error', + 'require-atomic-updates': 'error', + 'symbol-description': 'error', + 'vars-on-top': 'error', + '@typescript-eslint/explicit-member-accessibility': 'error', + '@typescript-eslint/no-this-alias': 'error', + '@typescript-eslint/no-explicit-any': 'error', + '@typescript-eslint/no-useless-constructor': 'error', + '@typescript-eslint/unified-signatures': 'error', + '@typescript-eslint/explicit-function-return-type': 'error', + '@typescript-eslint/no-non-null-assertion': 'error', + '@typescript-eslint/no-unused-vars': 'error', + 'no-template-curly-in-string': 'error', + 'sort-keys': 'error', + 'prefer-destructuring': 'error', + }, + }, /** * Alerting Services overrides */ @@ -1144,6 +1256,22 @@ module.exports = { }, }, + /** + * Discover overrides + */ + { + files: ['src/plugins/discover/**/*.{ts,tsx}'], + rules: { + '@typescript-eslint/no-explicit-any': 'error', + '@typescript-eslint/ban-ts-comment': [ + 'error', + { + 'ts-expect-error': false, + }, + ], + }, + }, + /** * Enterprise Search overrides * NOTE: We also have a single rule at the bottom of the file that @@ -1377,6 +1505,10 @@ module.exports = { ['parent', 'sibling', 'index'], ], pathGroups: [ + { + pattern: '{**,.}/*.test.mocks', + group: 'unknown', + }, { pattern: '{@kbn/**,src/**,kibana{,/**}}', group: 'internal', @@ -1402,6 +1534,24 @@ module.exports = { }, }, + /** + * Do not allow `any` + */ + { + files: [ + 'packages/kbn-analytics/**', + // 'packages/kbn-telemetry-tools/**', + 'src/plugins/kibana_usage_collection/**', + 'src/plugins/usage_collection/**', + 'src/plugins/telemetry/**', + 'src/plugins/telemetry_collection_manager/**', + 'src/plugins/telemetry_management_section/**', + 'x-pack/plugins/telemetry_collection_xpack/**', + ], + rules: { + '@typescript-eslint/no-explicit-any': 'error', + }, + }, { files: [ // core-team owned code diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index bafa023cf3f35..39daa5780436f 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -188,6 +188,7 @@ /src/core/ @elastic/kibana-core /src/plugins/saved_objects_tagging_oss @elastic/kibana-core /config/kibana.yml @elastic/kibana-core +/x-pack/plugins/banners/ @elastic/kibana-core /x-pack/plugins/features/ @elastic/kibana-core /x-pack/plugins/licensing/ @elastic/kibana-core /x-pack/plugins/global_search/ @elastic/kibana-core @@ -202,7 +203,6 @@ /packages/kbn-legacy-logging/ @elastic/kibana-core /packages/kbn-crypto/ @elastic/kibana-core /packages/kbn-http-tools/ @elastic/kibana-core -/src/plugins/status_page/ @elastic/kibana-core /src/plugins/saved_objects_management/ @elastic/kibana-core /src/dev/run_check_published_api_changes.ts @elastic/kibana-core /src/plugins/home/public @elastic/kibana-core @@ -214,7 +214,6 @@ #CC# /src/plugins/legacy_export/ @elastic/kibana-core #CC# /src/plugins/xpack_legacy/ @elastic/kibana-core #CC# /src/plugins/saved_objects/ @elastic/kibana-core -#CC# /src/plugins/status_page/ @elastic/kibana-core #CC# /x-pack/plugins/cloud/ @elastic/kibana-core #CC# /x-pack/plugins/features/ @elastic/kibana-core #CC# /x-pack/plugins/global_search/ @elastic/kibana-core diff --git a/BUILD.bazel b/BUILD.bazel index 4502daeaacb59..1f6e3030e5d0c 100644 --- a/BUILD.bazel +++ b/BUILD.bazel @@ -3,6 +3,7 @@ exports_files( [ "tsconfig.base.json", + "tsconfig.browser.json", "tsconfig.json", "package.json" ], diff --git a/Jenkinsfile b/Jenkinsfile index 8ab3fecb07a1b..db5ae306e6e2e 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -6,7 +6,7 @@ kibanaLibrary.load() kibanaPipeline(timeoutMinutes: 210, checkPrChanges: true, setCommitStatus: true) { slackNotifications.onFailure(disabled: !params.NOTIFY_ON_FAILURE) { githubPr.withDefaultPrComments { - ciStats.trackBuild { + ciStats.trackBuild(requireSuccess: githubPr.isTrackedBranchPr()) { catchError { retryable.enable() kibanaPipeline.allCiTasks() diff --git a/STYLEGUIDE.md b/STYLEGUIDE.md deleted file mode 100644 index cb75452a28cd2..0000000000000 --- a/STYLEGUIDE.md +++ /dev/null @@ -1,685 +0,0 @@ -# Kibana Style Guide - -This guide applies to all development within the Kibana project and is -recommended for the development of all Kibana plugins. - -- [General](#general) -- [HTML](#html) -- [API endpoints](#api-endpoints) -- [TypeScript/JavaScript](#typeScript/javaScript) -- [SASS files](#sass-files) -- [React](#react) - -Besides the content in this style guide, the following style guides may also apply -to all development within the Kibana project. Please make sure to also read them: - -- [Accessibility style guide (EUI Docs)](https://elastic.github.io/eui/#/guidelines/accessibility) -- [SASS style guide (EUI Docs)](https://elastic.github.io/eui/#/guidelines/sass) - -## General - -### Filenames - -All filenames should use `snake_case`. - -**Right:** `src/kibana/index_patterns/index_pattern.js` - -**Wrong:** `src/kibana/IndexPatterns/IndexPattern.js` - -### Do not comment out code - -We use a version management system. If a line of code is no longer needed, -remove it, don't simply comment it out. - -### Prettier and Linting - -We are gradually moving the Kibana code base over to Prettier. All TypeScript code -and some JavaScript code (check `.eslintrc.js`) is using Prettier to format code. You -can run `node script/eslint --fix` to fix linting issues and apply Prettier formatting. -We recommend you to enable running ESLint via your IDE. - -Whenever possible we are trying to use Prettier and linting over written style guide rules. -Consider every linting rule and every Prettier rule to be also part of our style guide -and disable them only in exceptional cases and ideally leave a comment why they are -disabled at that specific place. - -## HTML - -This part contains style guide rules around general (framework agnostic) HTML usage. - -### Camel case `id` and `data-test-subj` - -Use camel case for the values of attributes such as `id` and `data-test-subj` selectors. - -```html - -``` - -The only exception is in cases where you're dynamically creating the value, and you need to use -hyphens as delimiters: - -```jsx -buttons.map(btn => ( - -) -``` - -### Capitalization in HTML and CSS should always match - -It's important that when you write CSS/SASS selectors using classes, IDs, and attributes -(keeping in mind that we should _never_ use IDs and attributes in our selectors), that the -capitalization in the CSS matches that used in the HTML. HTML and CSS follow different case sensitivity rules, and we can avoid subtle gotchas by ensuring we use the -same capitalization in both of them. - -### How to generate ids? - -When labeling elements (and for some other accessibility tasks) you will often need -ids. Ids must be unique within the page i.e. no duplicate ids in the rendered DOM -at any time. - -Since we have some components that are used multiple times on the page, you must -make sure every instance of that component has a unique `id`. To make the generation -of those `id`s easier, you can use the `htmlIdGenerator` service in the `@elastic/eui`. - -A React component could use it as follows: - -```jsx -import { htmlIdGenerator } from '@elastic/eui'; - -render() { - // Create a new generator that will create ids deterministic - const htmlId = htmlIdGenerator(); - return (
- - -
); -} -``` - -Each id generator you create by calling `htmlIdGenerator()` will generate unique but -deterministic ids. As you can see in the above example, that single generator -created the same id in the label's `htmlFor` as well as the input's `id`. - -A single generator instance will create the same id when passed the same argument -to the function multiple times. But two different generators will produce two different -ids for the same argument to the function, as you can see in the following example: - -```js -const generatorOne = htmlIdGenerator(); -const generatorTwo = htmlIdGenerator(); - -// Those statements are always true: -// Same generator -generatorOne('foo') === generatorOne('foo'); -generatorOne('foo') !== generatorOne('bar'); - -// Different generator -generatorOne('foo') !== generatorTwo('foo'); -``` - -This allows multiple instances of a single React component to now have different ids. -If you include the above React component multiple times in the same page, -each component instance will have a unique id, because each render method will use a different -id generator. - -You can also use this service outside of React. - -## API endpoints - -The following style guide rules are targeting development of server side API endpoints. - -### Paths - -API routes must start with the `/api/` path segment, and should be followed by the plugin id if applicable: - -**Right:** `/api/marvel/nodes` - -**Wrong:** `/marvel/api/nodes` - -### snake_case - -Kibana uses `snake_case` for the entire API, just like Elasticsearch. All urls, paths, query string parameters, values, and bodies should be `snake_case` formatted. - -_Right:_ - -``` -POST /api/kibana/index_patterns -{ - "id": "...", - "time_field_name": "...", - "fields": [ - ... - ] -} -``` - -## TypeScript/JavaScript - -The following style guide rules apply for working with TypeScript/JavaScript files. - -### TypeScript vs. JavaScript - -Whenever possible, write code in TypeScript instead of JavaScript, especially if it's new code. -Check out [TYPESCRIPT.md](TYPESCRIPT.md) for help with this process. - -### Prefer modern JavaScript/TypeScript syntax - -You should prefer modern language features in a lot of cases, e.g.: - -- Prefer `class` over `prototype` inheritance -- Prefer arrow function over function expressions -- Prefer arrow function over storing `this` (no `const self = this;`) -- Prefer template strings over string concatenation -- Prefer the spread operator for copying arrays (`[...arr]`) over `arr.slice()` -- Use optional chaining (`?.`) and nullish Coalescing (`??`) over `lodash.get` (and similar utilities) - -### Avoid mutability and state - -Wherever possible, do not rely on mutable state. This means you should not -reassign variables, modify object properties, or push values to arrays. -Instead, create new variables, and shallow copies of objects and arrays: - -```js -// good -function addBar(foos, foo) { - const newFoo = { ...foo, name: 'bar' }; - return [...foos, newFoo]; -} - -// bad -function addBar(foos, foo) { - foo.name = 'bar'; - foos.push(foo); -} -``` - -### Avoid `any` whenever possible - -Since TypeScript 3.0 and the introduction of the -[`unknown` type](https://mariusschulz.com/blog/the-unknown-type-in-typescript) there are rarely any -reasons to use `any` as a type. Nearly all places of former `any` usage can be replace by either a -generic or `unknown` (in cases the type is really not known). - -You should always prefer using those mechanisms over using `any`, since they are stricter typed and -less likely to introduce bugs in the future due to insufficient types. - -If you’re not having `any` in your plugin or are starting a new plugin, you should enable the -[`@typescript-eslint/no-explicit-any`](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-explicit-any.md) -linting rule for your plugin via the [`.eslintrc.js`](https://github.com/elastic/kibana/blob/master/.eslintrc.js) config. - -### Avoid non-null assertions - -You should try avoiding non-null assertions (`!.`) wherever possible. By using them you tell -TypeScript, that something is not null even though by it’s type it could be. Usage of non-null -assertions is most often a side-effect of you actually checked that the variable is not `null` -but TypeScript doesn’t correctly carry on that information till the usage of the variable. - -In most cases it’s possible to replace the non-null assertion by structuring your code/checks slightly different -or using [user defined type guards](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards) -to properly tell TypeScript what type a variable has. - -Using non-null assertion increases the risk for future bugs. In case the condition under which we assumed that the -variable can’t be null has changed (potentially even due to changes in compeltely different files), the non-null -assertion would now wrongly disable proper type checking for us. - -If you’re not using non-null assertions in your plugin or are starting a new plugin, consider enabling the -[`@typescript-eslint/no-non-null-assertion`](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-non-null-assertion.md) -linting rule for you plugin in the [`.eslintrc.js`](https://github.com/elastic/kibana/blob/master/.eslintrc.js) config. - -### Return/throw early from functions - -To avoid deep nesting of if-statements, always return a function's value as early -as possible. And where possible, do any assertions first: - -```js -// good -function doStuff(val) { - if (val > 100) { - throw new Error('Too big'); - } - - if (val < 0) { - return false; - } - - // ... stuff -} - -// bad -function doStuff(val) { - if (val >= 0) { - if (val < 100) { - // ... stuff - } else { - throw new Error('Too big'); - } - } else { - return false; - } -} -``` - -### Use object destructuring - -This helps avoid temporary references and helps prevent typo-related bugs. - -```js -// best -function fullName({ first, last }) { - return `${first} ${last}`; -} - -// good -function fullName(user) { - const { first, last } = user; - return `${first} ${last}`; -} - -// bad -function fullName(user) { - const first = user.first; - const last = user.last; - return `${first} ${last}`; -} -``` - -### Use array destructuring - -Directly accessing array values via index should be avoided, but if it is -necessary, use array destructuring: - -```js -const arr = [1, 2, 3]; - -// good -const [first, second] = arr; - -// bad -const first = arr[0]; -const second = arr[1]; -``` - -### Magic numbers/strings - -These are numbers (or other values) simply used in line in your code. _Do not -use these_, give them a variable name so they can be understood and changed -easily. - -```js -// good -const minWidth = 300; - -if (width < minWidth) { - ... -} - -// bad -if (width < 300) { - ... -} -``` - -### Modules - -Module dependencies should be written using native ES2015 syntax wherever -possible (which is almost everywhere): - -```js -// good -import { mapValues } from 'lodash'; -export mapValues; - -// bad -const _ = require('lodash'); -module.exports = _.mapValues; - -// worse -define(['lodash'], function (_) { - ... -}); -``` - -In those extremely rare cases where you're writing server-side JavaScript in a -file that does not pass run through webpack, then use CommonJS modules. - -In those even rarer cases where you're writing client-side code that does not -run through webpack, then do not use a module loader at all. - -#### Import only top-level modules - -The files inside a module are implementation details of that module. They -should never be imported directly. Instead, you must only import the top-level -API that's exported by the module itself. - -Without a clear mechanism in place in JS to encapsulate protected code, we make -a broad assumption that anything beyond the root of a module is an -implementation detail of that module. - -On the other hand, a module should be able to import parent and sibling -modules. - -```js -// good -import foo from 'foo'; -import child from './child'; -import parent from '../'; -import ancestor from '../../../'; -import sibling from '../foo'; - -// bad -import inFoo from 'foo/child'; -import inSibling from '../foo/child'; -``` - -### Global definitions - -Don't do this. Everything should be wrapped in a module that can be depended on -by other modules. Even things as simple as a single value should be a module. - -### Only use ternary operators for small, simple code - -And _never_ use multiple ternaries together, because they make it more -difficult to reason about how different values flow through the conditions -involved. Instead, structure the logic for maximum readability. - -```js -// good, a situation where only 1 ternary is needed -const foo = a === b ? 1 : 2; - -// bad -const foo = a === b ? 1 : a === c ? 2 : 3; -``` - -### Use descriptive conditions - -Any non-trivial conditions should be converted to functions or assigned to -descriptively named variables. By breaking up logic into smaller, -self-contained blocks, it becomes easier to reason about the higher-level -logic. Additionally, these blocks become good candidates for extraction into -their own modules, with unit-tests. - -```js -// best -function isShape(thing) { - return thing instanceof Shape; -} -function notSquare(thing) { - return !(thing instanceof Square); -} -if (isShape(thing) && notSquare(thing)) { - ... -} - -// good -const isShape = thing instanceof Shape; -const notSquare = !(thing instanceof Square); -if (isShape && notSquare) { - ... -} - -// bad -if (thing instanceof Shape && !(thing instanceof Square)) { - ... -} -``` - -### Name regular expressions - -```js -// good -const validPassword = /^(?=.*\d).{4,}$/; - -if (password.length >= 4 && validPassword.test(password)) { - console.log('password is valid'); -} - -// bad -if (password.length >= 4 && /^(?=.*\d).{4,}$/.test(password)) { - console.log('losing'); -} -``` - -### Write small functions - -Keep your functions short. A good function fits on a slide that the people in -the last row of a big room can comfortably read. So don't count on them having -perfect vision and limit yourself to ~15 lines of code per function. - -### Use "rest" syntax rather than built-in `arguments` - -For expressiveness sake, and so you can be mix dynamic and explicit arguments. - -```js -// good -function something(foo, ...args) { - ... -} - -// bad -function something(foo) { - const args = Array.from(arguments).slice(1); - ... -} -``` - -### Default argument syntax - -Always use the default argument syntax for optional arguments. - -```js -// good -function foo(options = {}) { - ... -} - -// bad -function foo(options) { - if (typeof options === 'undefined') { - options = {}; - } - ... -} -``` - -And put your optional arguments at the end. - -```js -// good -function foo(bar, options = {}) { - ... -} - -// bad -function foo(options = {}, bar) { - ... -} -``` - -### Use thunks to create closures, where possible - -For trivial examples (like the one that follows), thunks will seem like -overkill, but they encourage isolating the implementation details of a closure -from the business logic of the calling code. - -```js -// good -function connectHandler(client, callback) { - return () => client.connect(callback); -} -setTimeout(connectHandler(client, afterConnect), 1000); - -// not as good -setTimeout(() => { - client.connect(afterConnect); -}, 1000); - -// bad -setTimeout(() => { - client.connect(() => { - ... - }); -}, 1000); -``` - -### Use slashes for comments - -Use slashes for both single line and multi line comments. Try to write -comments that explain higher level mechanisms or clarify difficult -segments of your code. _Don't use comments to restate trivial things_. - -_Exception:_ Comment blocks describing a function and its arguments -(docblock) should start with `/**`, contain a single `*` at the beginning of -each line, and end with `*/`. - -```js -// good - -// 'ID_SOMETHING=VALUE' -> ['ID_SOMETHING=VALUE', 'SOMETHING', 'VALUE'] -const matches = item.match(/ID_([^\n]+)=([^\n]+)/)); - -/** - * Fetches a user from... - * @param {string} id - id of the user - * @return {Promise} - */ -function loadUser(id) { - // This function has a nasty side effect where a failure to increment a - // redis counter used for statistics will cause an exception. This needs - // to be fixed in a later iteration. - - ... -} - -const isSessionValid = (session.expires < Date.now()); -if (isSessionValid) { - ... -} - -// bad - -// Execute a regex -const matches = item.match(/ID_([^\n]+)=([^\n]+)/)); - -// Usage: loadUser(5, function() { ... }) -function loadUser(id, cb) { - // ... -} - -// Check if the session is valid -const isSessionValid = (session.expires < Date.now()); -// If the session is valid -if (isSessionValid) { - ... -} -``` - -### Getters and Setters - -Feel free to use getters that are free from [side effects][sideeffect], like -providing a length property for a collection class. - -Do not use setters, they cause more problems than they can solve. - -[sideeffect]: http://en.wikipedia.org/wiki/Side_effect_(computer_science) - -### Avoid circular dependencies - -As part of a future effort to use correct and idempotent build tools we need our code to be -able to be represented as a directed acyclic graph. We must avoid having circular dependencies -both on code and type imports to achieve that. One of the most critical parts is the plugins -code. We've developed a tool to identify plugins with circular dependencies which -has allowed us to build a list of plugins who have circular dependencies -between each other. - -When building plugins we should avoid importing from plugins -who are known to have circular dependencies at the moment as well as introducing -new circular dependencies. You can run the same tool we use on our CI locally by -typing `node scripts/find_plugins_with_circular_deps --debug`. It will error out in -case new circular dependencies has been added with your changes -(which will also happen in the CI) as well as print out the current list of -the known circular dependencies which, as mentioned before, should not be imported -by your code until the circular dependencies on these have been solved. - -## SASS files - -When writing a new component, create a sibling SASS file of the same name and import directly into the **top** of the JS/TS component file. Doing so ensures the styles are never separated or lost on import and allows for better modularization (smaller individual plugin asset footprint). - -All SASS (.scss) files will automatically build with the [EUI](https://elastic.github.io/eui/#/guidelines/sass) & Kibana invisibles (SASS variables, mixins, functions) from the [`globals_[theme].scss` file](src/core/public/core_app/styles/_globals_v7light.scss). - -While the styles for this component will only be loaded if the component exists on the page, -the styles **will** be global and so it is recommended to use a three letter prefix on your -classes to ensure proper scope. - -**Example:** - -```tsx -// component.tsx - -import './component.scss'; -// All other imports below the SASS import - -export const Component = () => { - return ( -
- ); -} -``` - -```scss -// component.scss - -.plgComponent { ... } -``` - -Do not use the underscore `_` SASS file naming pattern when importing directly into a javascript file. - -## React - -The following style guide rules are specific for working with the React framework. - -### Prefer reactDirective over react-component - -When using `ngReact` to embed your react components inside Angular HTML, prefer the -`reactDirective` service over the `react-component` directive. -You can read more about these two ngReact methods [here](https://github.com/ngReact/ngReact#features). - -Using `react-component` means adding a bunch of components into angular, while `reactDirective` keeps them isolated, and is also a more succinct syntax. - -**Good:** - -```html - -``` - -**Bad:** - -```html - -``` - -### Action function names and prop function names - -Name action functions in the form of a strong verb and passed properties in the form of on. E.g: - -```jsx - - -``` - -## Attribution - -Parts of the JavaScript style guide were initially forked from the -[node style guide](https://github.com/felixge/node-style-guide) created by [Felix Geisendörfer](http://felixge.de/) which is -licensed under the [CC BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/) -license. diff --git a/STYLEGUIDE.mdx b/STYLEGUIDE.mdx new file mode 100644 index 0000000000000..afe00476640b3 --- /dev/null +++ b/STYLEGUIDE.mdx @@ -0,0 +1,695 @@ +--- +id: kibStyleGuide +slug: /kibana-dev-docs/styleguide +title: Style Guide +summary: JavaScript/TypeScript styleguide. +date: 2021-05-06 +tags: ['kibana', 'onboarding', 'dev', 'styleguide', 'typescript', 'javascript'] +--- + +This guide applies to all development within the Kibana project and is +recommended for the development of all Kibana plugins. + +Besides the content in this style guide, the following style guides may also apply +to all development within the Kibana project. Please make sure to also read them: + +- [Accessibility style guide (EUI Docs)](https://elastic.github.io/eui/#/guidelines/accessibility) +- [SASS style guide (EUI Docs)](https://elastic.github.io/eui/#/guidelines/sass) + +## General + +### Filenames + +All filenames should use `snake_case`. + +**Right:** `src/kibana/index_patterns/index_pattern.js` + +**Wrong:** `src/kibana/IndexPatterns/IndexPattern.js` + +### Do not comment out code + +We use a version management system. If a line of code is no longer needed, +remove it, don't simply comment it out. + +### Prettier and Linting + +We are gradually moving the Kibana code base over to Prettier. All TypeScript code +and some JavaScript code (check `.eslintrc.js`) is using Prettier to format code. You +can run `node script/eslint --fix` to fix linting issues and apply Prettier formatting. +We recommend you to enable running ESLint via your IDE. + +Whenever possible we are trying to use Prettier and linting over written style guide rules. +Consider every linting rule and every Prettier rule to be also part of our style guide +and disable them only in exceptional cases and ideally leave a comment why they are +disabled at that specific place. + +## HTML + +This part contains style guide rules around general (framework agnostic) HTML usage. + +### Camel case `id` and `data-test-subj` + +Use camel case for the values of attributes such as `id` and `data-test-subj` selectors. + +```html + +``` + +The only exception is in cases where you're dynamically creating the value, and you need to use +hyphens as delimiters: + +```jsx +buttons.map(btn => ( + +) +``` + +### Capitalization in HTML and CSS should always match + +It's important that when you write CSS/SASS selectors using classes, IDs, and attributes +(keeping in mind that we should _never_ use IDs and attributes in our selectors), that the +capitalization in the CSS matches that used in the HTML. HTML and CSS follow different case sensitivity rules, and we can avoid subtle gotchas by ensuring we use the +same capitalization in both of them. + +### How to generate ids? + +When labeling elements (and for some other accessibility tasks) you will often need +ids. Ids must be unique within the page i.e. no duplicate ids in the rendered DOM +at any time. + +Since we have some components that are used multiple times on the page, you must +make sure every instance of that component has a unique `id`. To make the generation +of those `id`s easier, you can use the `htmlIdGenerator` service in the `@elastic/eui`. + +A React component could use it as follows: + +```jsx +import { htmlIdGenerator } from '@elastic/eui'; + +render() { + // Create a new generator that will create ids deterministic + const htmlId = htmlIdGenerator(); + return (
+ + +
); +} +``` + +Each id generator you create by calling `htmlIdGenerator()` will generate unique but +deterministic ids. As you can see in the above example, that single generator +created the same id in the label's `htmlFor` as well as the input's `id`. + +A single generator instance will create the same id when passed the same argument +to the function multiple times. But two different generators will produce two different +ids for the same argument to the function, as you can see in the following example: + +```js +const generatorOne = htmlIdGenerator(); +const generatorTwo = htmlIdGenerator(); + +// Those statements are always true: +// Same generator +generatorOne('foo') === generatorOne('foo'); +generatorOne('foo') !== generatorOne('bar'); + +// Different generator +generatorOne('foo') !== generatorTwo('foo'); +``` + +This allows multiple instances of a single React component to now have different ids. +If you include the above React component multiple times in the same page, +each component instance will have a unique id, because each render method will use a different +id generator. + +You can also use this service outside of React. + +## API endpoints + +The following style guide rules are targeting development of server side API endpoints. + +### Paths + +API routes must start with the `/api/` path segment, and should be followed by the plugin id if applicable: + +**Right:** `/api/marvel/nodes` + +**Wrong:** `/marvel/api/nodes` + +### snake_case + +Kibana uses `snake_case` for the entire API, just like Elasticsearch. All urls, paths, query string parameters, values, and bodies should be `snake_case` formatted. + +_Right:_ + +``` +POST /api/kibana/index_patterns +{ + "id": "...", + "time_field_name": "...", + "fields": [ + ... + ] +} +``` + +## TypeScript/JavaScript + +The following style guide rules apply for working with TypeScript/JavaScript files. + +### TypeScript vs. JavaScript + +Whenever possible, write code in TypeScript instead of JavaScript, especially if it's new code. +Check out [TYPESCRIPT.md](TYPESCRIPT.md) for help with this process. + +### Prefer modern JavaScript/TypeScript syntax + +You should prefer modern language features in a lot of cases, e.g.: + +- Prefer `class` over `prototype` inheritance +- Prefer arrow function over function expressions +- Prefer arrow function over storing `this` (no `const self = this;`) +- Prefer template strings over string concatenation +- Prefer the spread operator for copying arrays (`[...arr]`) over `arr.slice()` +- Use optional chaining (`?.`) and nullish Coalescing (`??`) over `lodash.get` (and similar utilities) + +### Avoid mutability and state + +Wherever possible, do not rely on mutable state. This means you should not +reassign variables, modify object properties, or push values to arrays. +Instead, create new variables, and shallow copies of objects and arrays: + +```js +// good +function addBar(foos, foo) { + const newFoo = { ...foo, name: 'bar' }; + return [...foos, newFoo]; +} + +// bad +function addBar(foos, foo) { + foo.name = 'bar'; + foos.push(foo); +} +``` + +### Avoid `any` whenever possible + +Since TypeScript 3.0 and the introduction of the +[`unknown` type](https://mariusschulz.com/blog/the-unknown-type-in-typescript) there are rarely any +reasons to use `any` as a type. Nearly all places of former `any` usage can be replace by either a +generic or `unknown` (in cases the type is really not known). + +You should always prefer using those mechanisms over using `any`, since they are stricter typed and +less likely to introduce bugs in the future due to insufficient types. + +If you’re not having `any` in your plugin or are starting a new plugin, you should enable the +[`@typescript-eslint/no-explicit-any`](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-explicit-any.md) +linting rule for your plugin via the [`.eslintrc.js`](https://github.com/elastic/kibana/blob/master/.eslintrc.js) config. + +### Avoid non-null assertions + +You should try avoiding non-null assertions (`!.`) wherever possible. By using them you tell +TypeScript, that something is not null even though by it’s type it could be. Usage of non-null +assertions is most often a side-effect of you actually checked that the variable is not `null` +but TypeScript doesn’t correctly carry on that information till the usage of the variable. + +In most cases it’s possible to replace the non-null assertion by structuring your code/checks slightly different +or using [user defined type guards](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards) +to properly tell TypeScript what type a variable has. + +Using non-null assertion increases the risk for future bugs. In case the condition under which we assumed that the +variable can’t be null has changed (potentially even due to changes in compeltely different files), the non-null +assertion would now wrongly disable proper type checking for us. + +If you’re not using non-null assertions in your plugin or are starting a new plugin, consider enabling the +[`@typescript-eslint/no-non-null-assertion`](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-non-null-assertion.md) +linting rule for you plugin in the [`.eslintrc.js`](https://github.com/elastic/kibana/blob/master/.eslintrc.js) config. + +### Return/throw early from functions + +To avoid deep nesting of if-statements, always return a function's value as early +as possible. And where possible, do any assertions first: + +```js +// good +function doStuff(val) { + if (val > 100) { + throw new Error('Too big'); + } + + if (val < 0) { + return false; + } + + // ... stuff +} + +// bad +function doStuff(val) { + if (val >= 0) { + if (val < 100) { + // ... stuff + } else { + throw new Error('Too big'); + } + } else { + return false; + } +} +``` + +### Use object destructuring + +This helps avoid temporary references and helps prevent typo-related bugs. + +```js +// best +function fullName({ first, last }) { + return `${first} ${last}`; +} + +// good +function fullName(user) { + const { first, last } = user; + return `${first} ${last}`; +} + +// bad +function fullName(user) { + const first = user.first; + const last = user.last; + return `${first} ${last}`; +} +``` + +### Use array destructuring + +Directly accessing array values via index should be avoided, but if it is +necessary, use array destructuring: + +```js +const arr = [1, 2, 3]; + +// good +const [first, second] = arr; + +// bad +const first = arr[0]; +const second = arr[1]; +``` + +### Magic numbers/strings + +These are numbers (or other values) simply used in line in your code. _Do not +use these_, give them a variable name so they can be understood and changed +easily. + +```js +// good +const minWidth = 300; + +if (width < minWidth) { + ... +} + +// bad +if (width < 300) { + ... +} +``` + +### Modules + +Module dependencies should be written using native ES2015 syntax wherever +possible (which is almost everywhere): + +```js +// good +import { mapValues } from 'lodash'; +export mapValues; + +// bad +const _ = require('lodash'); +module.exports = _.mapValues; + +// worse +define(['lodash'], function (_) { + ... +}); +``` + +In those extremely rare cases where you're writing server-side JavaScript in a +file that does not pass run through webpack, then use CommonJS modules. + +In those even rarer cases where you're writing client-side code that does not +run through webpack, then do not use a module loader at all. + +#### Import only top-level modules + +The files inside a module are implementation details of that module. They +should never be imported directly. Instead, you must only import the top-level +API that's exported by the module itself. + +Without a clear mechanism in place in JS to encapsulate protected code, we make +a broad assumption that anything beyond the root of a module is an +implementation detail of that module. + +On the other hand, a module should be able to import parent and sibling +modules. + +```js +// good +import foo from 'foo'; +import child from './child'; +import parent from '../'; +import ancestor from '../../../'; +import sibling from '../foo'; + +// bad +import inFoo from 'foo/child'; +import inSibling from '../foo/child'; +``` + +#### Avoid export \* in top level index.ts files + +The exports in `common/index.ts`, `public/index.ts` and `server/index.ts` dictate a plugin's public API. The public API should be carefully controlled, and using `export *` makes it very easy for a developer working on internal changes to export a new public API unintentionally. + +```js +// good +export { foo } from 'foo'; +export { child } from './child'; + +// bad +export * from 'foo/child'; +export * from '../foo/child'; +``` + +### Global definitions + +Don't do this. Everything should be wrapped in a module that can be depended on +by other modules. Even things as simple as a single value should be a module. + +### Only use ternary operators for small, simple code + +And _never_ use multiple ternaries together, because they make it more +difficult to reason about how different values flow through the conditions +involved. Instead, structure the logic for maximum readability. + +```js +// good, a situation where only 1 ternary is needed +const foo = a === b ? 1 : 2; + +// bad +const foo = a === b ? 1 : a === c ? 2 : 3; +``` + +### Use descriptive conditions + +Any non-trivial conditions should be converted to functions or assigned to +descriptively named variables. By breaking up logic into smaller, +self-contained blocks, it becomes easier to reason about the higher-level +logic. Additionally, these blocks become good candidates for extraction into +their own modules, with unit-tests. + +```js +// best +function isShape(thing) { + return thing instanceof Shape; +} +function notSquare(thing) { + return !(thing instanceof Square); +} +if (isShape(thing) && notSquare(thing)) { + ... +} + +// good +const isShape = thing instanceof Shape; +const notSquare = !(thing instanceof Square); +if (isShape && notSquare) { + ... +} + +// bad +if (thing instanceof Shape && !(thing instanceof Square)) { + ... +} +``` + +### Name regular expressions + +```js +// good +const validPassword = /^(?=.*\d).{4,}$/; + +if (password.length >= 4 && validPassword.test(password)) { + console.log('password is valid'); +} + +// bad +if (password.length >= 4 && /^(?=.*\d).{4,}$/.test(password)) { + console.log('losing'); +} +``` + +### Write small functions + +Keep your functions short. A good function fits on a slide that the people in +the last row of a big room can comfortably read. So don't count on them having +perfect vision and limit yourself to ~15 lines of code per function. + +### Use "rest" syntax rather than built-in `arguments` + +For expressiveness sake, and so you can be mix dynamic and explicit arguments. + +```js +// good +function something(foo, ...args) { + ... +} + +// bad +function something(foo) { + const args = Array.from(arguments).slice(1); + ... +} +``` + +### Default argument syntax + +Always use the default argument syntax for optional arguments. + +```js +// good +function foo(options = {}) { + ... +} + +// bad +function foo(options) { + if (typeof options === 'undefined') { + options = {}; + } + ... +} +``` + +And put your optional arguments at the end. + +```js +// good +function foo(bar, options = {}) { + ... +} + +// bad +function foo(options = {}, bar) { + ... +} +``` + +### Use thunks to create closures, where possible + +For trivial examples (like the one that follows), thunks will seem like +overkill, but they encourage isolating the implementation details of a closure +from the business logic of the calling code. + +```js +// good +function connectHandler(client, callback) { + return () => client.connect(callback); +} +setTimeout(connectHandler(client, afterConnect), 1000); + +// not as good +setTimeout(() => { + client.connect(afterConnect); +}, 1000); + +// bad +setTimeout(() => { + client.connect(() => { + ... + }); +}, 1000); +``` + +### Use slashes for comments + +Use slashes for both single line and multi line comments. Try to write +comments that explain higher level mechanisms or clarify difficult +segments of your code. _Don't use comments to restate trivial things_. + +_Exception:_ Comment blocks describing a function and its arguments +(docblock) should start with `/**`, contain a single `*` at the beginning of +each line, and end with `*/`. + +```js +// good + +// 'ID_SOMETHING=VALUE' -> ['ID_SOMETHING=VALUE', 'SOMETHING', 'VALUE'] +const matches = item.match(/ID_([^\n]+)=([^\n]+)/)); + +/** + * Fetches a user from... + * @param {string} id - id of the user + * @return {Promise} + */ +function loadUser(id) { + // This function has a nasty side effect where a failure to increment a + // redis counter used for statistics will cause an exception. This needs + // to be fixed in a later iteration. + + ... +} + +const isSessionValid = (session.expires < Date.now()); +if (isSessionValid) { + ... +} + +// bad + +// Execute a regex +const matches = item.match(/ID_([^\n]+)=([^\n]+)/)); + +// Usage: loadUser(5, function() { ... }) +function loadUser(id, cb) { + // ... +} + +// Check if the session is valid +const isSessionValid = (session.expires < Date.now()); +// If the session is valid +if (isSessionValid) { + ... +} +``` + +### Getters and Setters + +Feel free to use getters that are free from [side effects][sideeffect], like +providing a length property for a collection class. + +Do not use setters, they cause more problems than they can solve. + +[sideeffect]: http://en.wikipedia.org/wiki/Side_effect_(computer_science) + +### Avoid circular dependencies + +As part of a future effort to use correct and idempotent build tools we need our code to be +able to be represented as a directed acyclic graph. We must avoid having circular dependencies +both on code and type imports to achieve that. One of the most critical parts is the plugins +code. We've developed a tool to identify plugins with circular dependencies which +has allowed us to build a list of plugins who have circular dependencies +between each other. + +When building plugins we should avoid importing from plugins +who are known to have circular dependencies at the moment as well as introducing +new circular dependencies. You can run the same tool we use on our CI locally by +typing `node scripts/find_plugins_with_circular_deps --debug`. It will error out in +case new circular dependencies has been added with your changes +(which will also happen in the CI) as well as print out the current list of +the known circular dependencies which, as mentioned before, should not be imported +by your code until the circular dependencies on these have been solved. + +## SASS files + +When writing a new component, create a sibling SASS file of the same name and import directly into the **top** of the JS/TS component file. Doing so ensures the styles are never separated or lost on import and allows for better modularization (smaller individual plugin asset footprint). + +All SASS (.scss) files will automatically build with the [EUI](https://elastic.github.io/eui/#/guidelines/sass) & Kibana invisibles (SASS variables, mixins, functions) from the [`globals_[theme].scss` file](src/core/public/core_app/styles/_globals_v7light.scss). + +While the styles for this component will only be loaded if the component exists on the page, +the styles **will** be global and so it is recommended to use a three letter prefix on your +classes to ensure proper scope. + +**Example:** + +```tsx +// component.tsx + +import './component.scss'; +// All other imports below the SASS import + +export const Component = () => { + return
; +}; +``` + +```scss +// component.scss + +.plgComponent { ... } +``` + +Do not use the underscore `_` SASS file naming pattern when importing directly into a javascript file. + +## React + +The following style guide rules are specific for working with the React framework. + +### Prefer reactDirective over react-component + +When using `ngReact` to embed your react components inside Angular HTML, prefer the +`reactDirective` service over the `react-component` directive. +You can read more about these two ngReact methods [here](https://github.com/ngReact/ngReact#features). + +Using `react-component` means adding a bunch of components into angular, while `reactDirective` keeps them isolated, and is also a more succinct syntax. + +**Good:** + +```html + +``` + +**Bad:** + +```html + +``` + +### Action function names and prop function names + +Name action functions in the form of a strong verb and passed properties in the form of `on`. E.g: + +```jsx + + +``` + +## Attribution + +Parts of the JavaScript style guide were initially forked from the +[node style guide](https://github.com/felixge/node-style-guide) created by [Felix Geisendörfer](http://felixge.de/) which is +licensed under the [CC BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/) +license. diff --git a/WORKSPACE.bazel b/WORKSPACE.bazel index bd4d8801b0d4e..60af851ff2dc6 100644 --- a/WORKSPACE.bazel +++ b/WORKSPACE.bazel @@ -10,15 +10,15 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") # Fetch Node.js rules http_archive( name = "build_bazel_rules_nodejs", - sha256 = "dd7ea7efda7655c218ca707f55c3e1b9c68055a70c31a98f264b3445bc8f4cb1", - urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/3.2.3/rules_nodejs-3.2.3.tar.gz"], + sha256 = "10f534e1c80f795cffe1f2822becd4897754d18564612510c59b3c73544ae7c6", + urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/3.5.0/rules_nodejs-3.5.0.tar.gz"], ) # Now that we have the rules let's import from them to complete the work load("@build_bazel_rules_nodejs//:index.bzl", "check_rules_nodejs_version", "node_repositories", "yarn_install") # Assure we have at least a given rules_nodejs version -check_rules_nodejs_version(minimum_version_string = "3.2.3") +check_rules_nodejs_version(minimum_version_string = "3.5.0") # Setup the Node.js toolchain for the architectures we want to support # diff --git a/api_docs/actions.json b/api_docs/actions.json index 1a92e7270d4fb..1c08a3661cc24 100644 --- a/api_docs/actions.json +++ b/api_docs/actions.json @@ -12,9 +12,12 @@ "classes": [], "functions": [ { + "parentPluginId": "actions", "id": "def-server.asHttpRequestExecutionSource", "type": "Function", + "tags": [], "label": "asHttpRequestExecutionSource", + "description": [], "signature": [ "(source: ", { @@ -27,13 +30,19 @@ ") => ", "HttpRequestExecutionSource" ], - "description": [], + "source": { + "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.asHttpRequestExecutionSource.$1", "type": "Object", + "tags": [], "label": "source", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -44,64 +53,68 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.asSavedObjectExecutionSource", "type": "Function", + "tags": [], "label": "asSavedObjectExecutionSource", + "description": [], "signature": [ "(source: Pick<", "SavedObjectReference", ", \"type\" | \"id\">) => ", "SavedObjectExecutionSource" ], - "description": [], + "source": { + "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.asSavedObjectExecutionSource.$1", "type": "Object", + "tags": [], "label": "source", - "isRequired": true, + "description": [], "signature": [ "Pick<", "SavedObjectReference", ", \"type\" | \"id\">" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", - "lineNumber": 29 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "actions", "id": "def-server.ActionResult", "type": "Interface", + "tags": [], "label": "ActionResult", + "description": [], "signature": [ { "pluginId": "actions", @@ -112,91 +125,119 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionResult.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 63 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionResult.actionTypeId", "type": "string", + "tags": [], "label": "actionTypeId", "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 64 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionResult.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 65 - } + }, + "deprecated": false }, { + "parentPluginId": "actions", + "id": "def-server.ActionResult.isMissingSecrets", + "type": "CompoundType", "tags": [], - "id": "def-server.ActionResult.config", - "type": "Uncategorized", - "label": "config", + "label": "isMissingSecrets", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 66 }, + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.ActionResult.config", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [], "signature": [ "Config | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 67 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionResult.isPreconfigured", "type": "boolean", + "tags": [], "label": "isPreconfigured", "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 67 - } + "lineNumber": 68 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 62 - }, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionsApiRequestHandlerContext", "type": "Interface", + "tags": [], "label": "ActionsApiRequestHandlerContext", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionsApiRequestHandlerContext.getActionsClient", "type": "Function", + "tags": [], "label": "getActionsClient", "description": [], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 40 - }, "signature": [ "() => ", { @@ -206,18 +247,20 @@ "section": "def-server.ActionsClient", "text": "ActionsClient" } - ] + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 40 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionsApiRequestHandlerContext.listTypes", "type": "Function", + "tags": [], "label": "listTypes", "description": [], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 41 - }, "signature": [ "() => ", { @@ -228,32 +271,36 @@ "text": "ActionType" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 41 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 39 - }, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionsPlugin", "type": "Interface", + "tags": [], "label": "ActionsPlugin", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionsPlugin.setup", "type": "Object", + "tags": [], "label": "setup", "description": [], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 49 - }, "signature": [ { "pluginId": "actions", @@ -262,18 +309,20 @@ "section": "def-server.PluginSetupContract", "text": "PluginSetupContract" } - ] + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 49 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionsPlugin.start", "type": "Object", + "tags": [], "label": "start", "description": [], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 50 - }, "signature": [ { "pluginId": "actions", @@ -282,19 +331,23 @@ "section": "def-server.PluginStartContract", "text": "PluginStartContract" } - ] + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 50 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionType", "type": "Interface", + "tags": [], "label": "ActionType", + "description": [], "signature": [ { "pluginId": "actions", @@ -305,158 +358,183 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 96 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionType.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 101 - } + "lineNumber": 102 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 102 - } + "lineNumber": 103 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionType.maxAttempts", "type": "number", + "tags": [], "label": "maxAttempts", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 103 + "lineNumber": 104 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionType.minimumLicenseRequired", "type": "CompoundType", + "tags": [], "label": "minimumLicenseRequired", "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 104 + "lineNumber": 105 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionType.validate", "type": "Object", + "tags": [], "label": "validate", "description": [], + "signature": [ + "{ params?: ValidatorType | undefined; config?: ValidatorType | undefined; secrets?: ValidatorType | undefined; } | undefined" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 105 + "lineNumber": 106 }, - "signature": [ - "{ params?: ValidatorType | undefined; config?: ValidatorType | undefined; secrets?: ValidatorType | undefined; } | undefined" - ] + "deprecated": false }, { + "parentPluginId": "actions", "id": "def-server.ActionType.renderParameterTemplates", "type": "Function", + "tags": [], "label": "renderParameterTemplates", + "description": [], "signature": [ "((params: Params, variables: Record, actionId?: string | undefined) => Params) | undefined" ], - "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 111 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.ActionType.renderParameterTemplates.$1", "type": "Uncategorized", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "Params" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 111 - } + "lineNumber": 112 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "actions", "id": "def-server.ActionType.renderParameterTemplates.$2", "type": "Object", + "tags": [], "label": "variables", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 112 - } + "lineNumber": 113 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "actions", "id": "def-server.ActionType.renderParameterTemplates.$3", "type": "string", + "tags": [], "label": "actionId", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 113 - } + "lineNumber": 114 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 110 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionType.executor", "type": "Function", + "tags": [], "label": "executor", "description": [], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 115 - }, "signature": [ "ExecutorType", "" - ] + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 116 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 95 - }, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions", "type": "Interface", + "tags": [], "label": "ActionTypeExecutorOptions", + "description": [], "signature": [ { "pluginId": "actions", @@ -467,87 +545,99 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.actionId", "type": "string", + "tags": [], "label": "actionId", "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.services", "type": "Object", + "tags": [], "label": "services", "description": [], + "signature": [ + "Services" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 56 }, - "signature": [ - "Services" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.config", "type": "Uncategorized", + "tags": [], "label": "config", "description": [], + "signature": [ + "Config" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 57 }, - "signature": [ - "Config" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.secrets", "type": "Uncategorized", + "tags": [], "label": "secrets", "description": [], + "signature": [ + "Secrets" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 58 }, - "signature": [ - "Secrets" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.params", "type": "Uncategorized", + "tags": [], "label": "params", "description": [], + "signature": [ + "Params" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 59 }, - "signature": [ - "Params" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.PreConfiguredAction", "type": "Interface", + "tags": [], "label": "PreConfiguredAction", + "description": [], "signature": [ { "pluginId": "actions", @@ -566,208 +656,245 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-server.PreConfiguredAction.secrets", "type": "Uncategorized", + "tags": [], "label": "secrets", "description": [], + "signature": [ + "Secrets" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 74 + "lineNumber": 75 }, - "signature": [ - "Secrets" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 70 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "actions", + "id": "def-server.ACTION_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "ACTION_SAVED_OBJECT_TYPE", + "description": [], + "signature": [ + "\"action\"" + ], + "source": { + "path": "x-pack/plugins/actions/server/constants/saved_objects.ts", + "lineNumber": 8 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionParamsType", "tags": [], + "label": "ActionParamsType", "description": [], + "signature": [ + "{ readonly to: string[]; readonly message: string; readonly cc: string[]; readonly bcc: string[]; readonly subject: string; readonly kibanaFooterLink: Readonly<{} & { text: string; path: string; }>; }" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/email.ts", "lineNumber": 99 }, - "signature": [ - "{ readonly to: string[]; readonly message: string; readonly cc: string[]; readonly bcc: string[]; readonly subject: string; readonly kibanaFooterLink: Readonly<{} & { text: string; path: string; }>; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionParamsType", "tags": [], + "label": "ActionParamsType", "description": [], + "signature": [ + "{ readonly documents: Record[]; readonly indexOverride: string | null; }" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", "lineNumber": 36 }, - "signature": [ - "{ readonly documents: Record[]; readonly indexOverride: string | null; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionParamsType", "tags": [], + "label": "ActionParamsType", "description": [], + "signature": [ + "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"info\" | \"error\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", "lineNumber": 50 }, - "signature": [ - "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"info\" | \"error\" | \"critical\" | undefined; readonly timestamp?: string | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionParamsType", "tags": [], + "label": "ActionParamsType", "description": [], + "signature": [ + "{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", "lineNumber": 25 }, - "signature": [ - "{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionParamsType", "tags": [], + "label": "ActionParamsType", "description": [], + "signature": [ + "{ readonly message: string; }" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", "lineNumber": 48 }, - "signature": [ - "{ readonly message: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionParamsType", "tags": [], + "label": "ActionParamsType", "description": [], + "signature": [ + "{ readonly body?: string | undefined; }" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts", "lineNumber": 71 }, - "signature": [ - "{ readonly body?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionParamsType", "tags": [], + "label": "ActionParamsType", "description": [], + "signature": [ + "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; severity: string | null; externalId: string | null; urgency: string | null; impact: string | null; short_description: string; subcategory: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }> | Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; short_description: string; subcategory: string | null; dest_ip: string | null; malware_hash: string | null; malware_url: string | null; source_ip: string | null; priority: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }>" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", "lineNumber": 35 }, - "signature": [ - "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; severity: string | null; externalId: string | null; urgency: string | null; impact: string | null; short_description: string; subcategory: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }> | Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; short_description: string; subcategory: string | null; dest_ip: string | null; malware_hash: string | null; malware_url: string | null; source_ip: string | null; priority: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionParamsType", "tags": [], + "label": "ActionParamsType", "description": [], + "signature": [ + "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; parent: string | null; summary: string; externalId: string | null; priority: string | null; issueType: string | null; labels: string[] | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"issueTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"fieldsByIssueType\"; subActionParams: Readonly<{} & { id: string; }>; }> | Readonly<{} & { subAction: \"issues\"; subActionParams: Readonly<{} & { title: string; }>; }> | Readonly<{} & { subAction: \"issue\"; subActionParams: Readonly<{} & { id: string; }>; }>" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts", "lineNumber": 36 }, - "signature": [ - "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; parent: string | null; summary: string; externalId: string | null; priority: string | null; issueType: string | null; labels: string[] | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"issueTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"fieldsByIssueType\"; subActionParams: Readonly<{} & { id: string; }>; }> | Readonly<{} & { subAction: \"issues\"; subActionParams: Readonly<{} & { title: string; }>; }> | Readonly<{} & { subAction: \"issue\"; subActionParams: Readonly<{} & { id: string; }>; }>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionParamsType", "tags": [], + "label": "ActionParamsType", "description": [], + "signature": [ + "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; name: string; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts", "lineNumber": 34 }, - "signature": [ - "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; name: string; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionParamsType", "tags": [], + "label": "ActionParamsType", "description": [], + "signature": [ + "{ readonly message: string; }" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts", "lineNumber": 40 }, - "signature": [ - "{ readonly message: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionsAuthorization", "type": "Type", - "label": "ActionsAuthorization", "tags": [], + "label": "ActionsAuthorization", "description": [], + "signature": [ + "{ ensureAuthorized: (operation: string, actionTypeId?: string | undefined) => Promise; }" + ], "source": { "path": "x-pack/plugins/actions/server/index.ts", "lineNumber": 16 }, - "signature": [ - "{ ensureAuthorized: (operation: string, actionTypeId?: string | undefined) => Promise; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionsClient", "type": "Type", - "label": "ActionsClient", "tags": [], + "label": "ActionsClient", "description": [], - "source": { - "path": "x-pack/plugins/actions/server/index.ts", - "lineNumber": 15 - }, "signature": [ "{ get: ({ id }: { id: string; }) => Promise<", { @@ -798,186 +925,222 @@ "text": "ActionResult" } ], + "source": { + "path": "x-pack/plugins/actions/server/index.ts", + "lineNumber": 15 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", + "tags": [], "label": "ActionTypeId", "description": [], + "signature": [ + "\".email\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/email.ts", "lineNumber": 143 }, - "signature": [ - "\".email\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", + "tags": [], "label": "ActionTypeId", "description": [], + "signature": [ + "\".index\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", "lineNumber": 54 }, - "signature": [ - "\".index\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", + "tags": [], "label": "ActionTypeId", "description": [], + "signature": [ + "\".pagerduty\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", "lineNumber": 121 }, - "signature": [ - "\".pagerduty\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", + "tags": [], "label": "ActionTypeId", "description": [], + "signature": [ + "\".server-log\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", "lineNumber": 42 }, - "signature": [ - "\".server-log\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", + "tags": [], "label": "ActionTypeId", "description": [], + "signature": [ + "\".slack\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", "lineNumber": 56 }, - "signature": [ - "\".slack\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", + "tags": [], "label": "ActionTypeId", "description": [], + "signature": [ + "\".webhook\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts", "lineNumber": 76 }, - "signature": [ - "\".webhook\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", + "tags": [], "label": "ActionTypeId", "description": [], + "signature": [ + "\".jira\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts", "lineNumber": 52 }, - "signature": [ - "\".jira\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", + "tags": [], "label": "ActionTypeId", "description": [], + "signature": [ + "\".resilient\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts", "lineNumber": 43 }, - "signature": [ - "\".resilient\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", + "tags": [], "label": "ActionTypeId", "description": [], + "signature": [ + "\".teams\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts", "lineNumber": 46 }, - "signature": [ - "\".teams\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ServiceNowITSMActionTypeId", "type": "string", + "tags": [], "label": "ServiceNowITSMActionTypeId", "description": [], + "signature": [ + "\".servicenow\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", "lineNumber": 47 }, - "signature": [ - "\".servicenow\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ServiceNowSIRActionTypeId", "type": "string", + "tags": [], "label": "ServiceNowSIRActionTypeId", "description": [], + "signature": [ + "\".servicenow-sir\"" + ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", "lineNumber": 48 }, - "signature": [ - "\".servicenow-sir\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "actions", "id": "def-server.PluginSetupContract", "type": "Interface", + "tags": [], "label": "PluginSetupContract", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 87 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.PluginSetupContract.registerType", "type": "Function", + "tags": [], "label": "registerType", + "description": [], "signature": [ " = Record, Secrets extends Record = Record, Params extends Record = Record, ExecutorResultData = void>(actionType: ", { @@ -989,13 +1152,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 88 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.PluginSetupContract.registerType.$1", "type": "Object", + "tags": [], "label": "actionType", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "actions", @@ -1006,163 +1175,185 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 88 - } + "lineNumber": 94 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 82 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 81 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "actions", "id": "def-server.PluginStartContract", "type": "Interface", + "tags": [], "label": "PluginStartContract", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionTypeEnabled", "type": "Function", + "tags": [], "label": "isActionTypeEnabled", + "description": [], "signature": [ "(id: string, options?: { notifyUsage: boolean; } | undefined) => boolean" ], - "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 99 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionTypeEnabled.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93 - } + "lineNumber": 99 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionTypeEnabled.$2.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 99 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionTypeEnabled.$2.options.notifyUsage", "type": "boolean", + "tags": [], "label": "notifyUsage", "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93 - } + "lineNumber": 99 + }, + "deprecated": false } - ], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93 - } + "returnComment": [] }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionExecutable", "type": "Function", + "tags": [], "label": "isActionExecutable", + "description": [], "signature": [ "(actionId: string, actionTypeId: string, options?: { notifyUsage: boolean; } | undefined) => boolean" ], - "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 100 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionExecutable.$1", "type": "string", + "tags": [], "label": "actionId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 95 - } + "lineNumber": 101 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionExecutable.$2", "type": "string", + "tags": [], "label": "actionTypeId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 96 - } + "lineNumber": 102 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionExecutable.$3.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 103 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionExecutable.$3.options.notifyUsage", "type": "boolean", + "tags": [], "label": "notifyUsage", "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 97 - } + "lineNumber": 103 + }, + "deprecated": false } - ], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 97 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 94 - } + "returnComment": [] }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.getActionsClientWithRequest", "type": "Function", + "tags": [], "label": "getActionsClientWithRequest", + "description": [], "signature": [ "(request: ", { @@ -1182,13 +1373,19 @@ }, ", \"get\" | \"delete\" | \"create\" | \"update\" | \"execute\" | \"getAll\" | \"getBulk\" | \"enqueueExecution\" | \"listTypes\" | \"isActionTypeEnabled\">>" ], - "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 105 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.getActionsClientWithRequest.$1", "type": "Object", + "tags": [], "label": "request", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1199,24 +1396,23 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 99 - } + "lineNumber": 105 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 99 - } + "returnComment": [] }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest", "type": "Function", + "tags": [], "label": "getActionsAuthorizationWithRequest", + "description": [], "signature": [ "(request: ", { @@ -1236,13 +1432,19 @@ }, ", \"ensureAuthorized\">" ], - "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 106 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest.$1", "type": "Object", + "tags": [], "label": "request", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1253,30 +1455,23 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 100 - } + "lineNumber": 106 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 100 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.PluginStartContract.preconfiguredActions", "type": "Array", + "tags": [], "label": "preconfiguredActions", "description": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 101 - }, "signature": [ { "pluginId": "actions", @@ -1286,86 +1481,101 @@ "text": "PreConfiguredAction" }, ", Record>[]" - ] + ], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 107 + }, + "deprecated": false }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.renderActionParameterTemplates", "type": "Function", + "tags": [], "label": "renderActionParameterTemplates", + "description": [], "signature": [ " = Record>(actionTypeId: string, actionId: string, params: Params, variables: Record) => Params" ], - "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 108 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.renderActionParameterTemplates.$1", "type": "string", + "tags": [], "label": "actionTypeId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 103 - } + "lineNumber": 109 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.renderActionParameterTemplates.$2", "type": "string", + "tags": [], "label": "actionId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 104 - } + "lineNumber": 110 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.renderActionParameterTemplates.$3", "type": "Uncategorized", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "Params" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 105 - } + "lineNumber": 111 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.renderActionParameterTemplates.$4", "type": "Object", + "tags": [], "label": "variables", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 106 - } + "lineNumber": 112 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 102 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 92 - }, "lifecycle": "start", "initialIsOpen": true } @@ -1374,230 +1584,269 @@ "classes": [], "functions": [ { + "parentPluginId": "actions", "id": "def-common.buildAlertHistoryDocument", "type": "Function", + "tags": [], + "label": "buildAlertHistoryDocument", + "description": [], + "signature": [ + "(variables: Record) => { event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record; }; name?: string; id?: string; }; message?: unknown; tags?: string[]; '@timestamp': string; } | null" + ], + "source": { + "path": "x-pack/plugins/actions/common/alert_history_schema.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-common.buildAlertHistoryDocument.$1", "type": "Object", + "tags": [], "label": "variables", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(variables: Record) => { event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record; }; name?: string; id?: string; }; message?: unknown; tags?: string[]; '@timestamp': string; } | null" - ], - "description": [], - "label": "buildAlertHistoryDocument", - "source": { - "path": "x-pack/plugins/actions/common/alert_history_schema.ts", - "lineNumber": 14 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-common.isActionTypeExecutorResult", "type": "Function", + "tags": [], "label": "isActionTypeExecutorResult", + "description": [], "signature": [ "(result: unknown) => boolean" ], - "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { + "parentPluginId": "actions", "id": "def-common.isActionTypeExecutorResult.$1", "type": "Unknown", + "tags": [], "label": "result", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/common/types.ts", - "lineNumber": 42 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "actions", "id": "def-common.ActionResult", "type": "Interface", + "tags": [], "label": "ActionResult", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionResult.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionResult.actionTypeId", "type": "string", + "tags": [], "label": "actionTypeId", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionResult.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionResult.config", "type": "Object", + "tags": [], "label": "config", "description": [], + "signature": [ + "Record" + ], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 25 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionResult.isPreconfigured", "type": "boolean", + "tags": [], "label": "isPreconfigured", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 26 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/common/types.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-common.ActionType", "type": "Interface", + "tags": [], "label": "ActionType", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionType.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 11 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionType.enabled", "type": "boolean", + "tags": [], "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionType.enabledInConfig", "type": "boolean", + "tags": [], "label": "enabledInConfig", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionType.enabledInLicense", "type": "boolean", + "tags": [], "label": "enabledInLicense", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionType.minimumLicenseRequired", "type": "CompoundType", + "tags": [], "label": "minimumLicenseRequired", "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 16 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/common/types.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult", "type": "Interface", + "tags": [], "label": "ActionTypeExecutorResult", + "description": [], "signature": [ { "pluginId": "actions", @@ -1608,197 +1857,217 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.actionId", "type": "string", + "tags": [], "label": "actionId", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 34 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.status", "type": "CompoundType", + "tags": [], "label": "status", "description": [], + "signature": [ + "\"error\" | \"ok\"" + ], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 35 }, - "signature": [ - "\"error\" | \"ok\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.message", "type": "string", + "tags": [], "label": "message", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 36 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.serviceMessage", "type": "string", + "tags": [], "label": "serviceMessage", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 37 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.data", "type": "Uncategorized", + "tags": [], "label": "data", "description": [], + "signature": [ + "Data | undefined" + ], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 38 }, - "signature": [ - "Data | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.retry", "type": "CompoundType", + "tags": [], "label": "retry", "description": [], + "signature": [ + "boolean | Date | null | undefined" + ], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 39 }, - "signature": [ - "boolean | Date | null | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/common/types.ts", - "lineNumber": 33 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "actions", "id": "def-common.ALERT_HISTORY_PREFIX", "type": "string", + "tags": [], "label": "ALERT_HISTORY_PREFIX", "description": [], + "signature": [ + "\"kibana-alert-history-\"" + ], "source": { "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "lineNumber": 10 }, - "signature": [ - "\"kibana-alert-history-\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.AlertHistoryDefaultIndexName", "type": "string", + "tags": [], "label": "AlertHistoryDefaultIndexName", "description": [], "source": { "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "lineNumber": 11 }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.AlertHistoryDocumentTemplate", "type": "CompoundType", + "tags": [], "label": "AlertHistoryDocumentTemplate", "description": [], + "signature": [ + "Readonly<{ event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record; }; name?: string; id?: string; }; message?: unknown; tags?: string[]; '@timestamp': string; }> | null" + ], "source": { "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "lineNumber": 73 }, - "signature": [ - "Readonly<{ event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record; }; name?: string; id?: string; }; message?: unknown; tags?: string[]; '@timestamp': string; }> | null" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.AlertHistoryEsIndexConnectorId", "type": "string", + "tags": [], "label": "AlertHistoryEsIndexConnectorId", "description": [], + "signature": [ + "\"preconfigured-alert-history-es-index\"" + ], "source": { "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "lineNumber": 12 }, - "signature": [ - "\"preconfigured-alert-history-es-index\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-common.AsApiContract", "type": "Type", - "label": "AsApiContract", "tags": [], + "label": "AsApiContract", "description": [], + "signature": [ + "{ [K in keyof T as CamelToSnake>>]: T[K]; }" + ], "source": { "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", "lineNumber": 14 }, - "signature": [ - "{ [K in keyof T as CamelToSnake>>]: T[K]; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "actions", "id": "def-common.BASE_ACTION_API_PATH", "type": "string", + "tags": [], "label": "BASE_ACTION_API_PATH", "description": [], + "signature": [ + "\"/api/actions\"" + ], "source": { "path": "x-pack/plugins/actions/common/index.ts", "lineNumber": 12 }, - "signature": [ - "\"/api/actions\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-common.RewriteRequestCase", "type": "Type", - "label": "RewriteRequestCase", "tags": [], + "label": "RewriteRequestCase", "description": [], - "source": { - "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", - "lineNumber": 18 - }, "signature": [ "(requested: ", { @@ -1810,18 +2079,20 @@ }, ") => T" ], + "source": { + "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", + "lineNumber": 18 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-common.RewriteResponseCase", "type": "Type", - "label": "RewriteResponseCase", "tags": [], + "label": "RewriteResponseCase", "description": [], - "source": { - "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", - "lineNumber": 19 - }, "signature": [ "(responded: T) => T extends (infer Item)[] ? ", { @@ -1841,6 +2112,11 @@ }, "" ], + "source": { + "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", + "lineNumber": 19 + }, + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/advanced_settings.json b/api_docs/advanced_settings.json index 18ff69de69c64..791915c9fcd61 100644 --- a/api_docs/advanced_settings.json +++ b/api_docs/advanced_settings.json @@ -3,201 +3,229 @@ "client": { "classes": [ { + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry", "type": "Class", "tags": [], "label": "ComponentRegistry", "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.componentType", "type": "Object", + "tags": [], "label": "componentType", "description": [], + "signature": [ + "{ [key: string]: Id; }" + ], "source": { "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 28 }, - "signature": [ - "{ [key: string]: Id; }" - ] + "deprecated": false }, { + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.defaultRegistry", "type": "Object", "tags": [], + "label": "defaultRegistry", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_title", "type": "Function", + "tags": [], "label": "advanced_settings_page_title", "description": [], + "signature": [ + "() => JSX.Element" + ], "source": { "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 30 }, - "signature": [ - "() => JSX.Element" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_subtitle", "type": "Function", + "tags": [], "label": "advanced_settings_page_subtitle", "description": [], + "signature": [ + "() => null" + ], "source": { "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 31 }, - "signature": [ - "() => null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_footer", "type": "Function", + "tags": [], "label": "advanced_settings_page_footer", "description": [], + "signature": [ + "() => null" + ], "source": { "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 32 }, - "signature": [ - "() => null" - ] + "deprecated": false } - ], - "description": [], - "label": "defaultRegistry", - "source": { - "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", - "lineNumber": 29 - } + ] }, { + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.registry", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "registry", + "description": [], "source": { "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "children": [] }, { + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.setup", "type": "Object", "tags": [], + "label": "setup", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.setup.componentType", "type": "Object", + "tags": [], "label": "componentType", "description": [], + "signature": [ + "{ [key: string]: Id; }" + ], "source": { "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 72 }, - "signature": [ - "{ [key: string]: Id; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.setup.register", "type": "Function", + "tags": [], "label": "register", "description": [], + "signature": [ + "(id: Id, component: React.ComponentType | undefined>, allowOverride?: boolean) => void" + ], "source": { "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 73 }, - "signature": [ - "(id: Id, component: React.ComponentType | undefined>, allowOverride?: boolean) => void" - ] + "deprecated": false } - ], - "description": [], - "label": "setup", - "source": { - "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", - "lineNumber": 71 - } + ] }, { + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.start", "type": "Object", "tags": [], + "label": "start", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 76 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.start.componentType", "type": "Object", + "tags": [], "label": "componentType", "description": [], + "signature": [ + "{ [key: string]: Id; }" + ], "source": { "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 77 }, - "signature": [ - "{ [key: string]: Id; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.start.get", "type": "Function", + "tags": [], "label": "get", "description": [], + "signature": [ + "(id: Id) => React.ComponentType | undefined>" + ], "source": { "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 78 }, - "signature": [ - "(id: Id) => React.ComponentType | undefined>" - ] + "deprecated": false } - ], - "description": [], - "label": "start", - "source": { - "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", - "lineNumber": 76 - } + ] } ], - "source": { - "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", - "lineNumber": 27 - }, "initialIsOpen": false } ], "functions": [ { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.LazyField", "type": "Function", + "tags": [], "label": "LazyField", "description": [ "\nExports the field component as a React.lazy component. We're explicitly naming it lazy here\nso any plugin that would import that can clearly see it's lazy loaded and can only be used\ninside a suspense context." ], - "source": { - "path": "src/plugins/advanced_settings/public/index.ts", - "lineNumber": 20 - }, "signature": [ "React.LazyExoticComponent" ], + "source": { + "path": "src/plugins/advanced_settings/public/index.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false } ], @@ -206,60 +234,68 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "advancedSettings", "id": "def-public.AdvancedSettingsSetup", "type": "Interface", + "tags": [], "label": "AdvancedSettingsSetup", "description": [], - "tags": [], + "source": { + "path": "src/plugins/advanced_settings/public/types.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.AdvancedSettingsSetup.component", "type": "Object", + "tags": [], "label": "component", "description": [], + "signature": [ + "{ componentType: { [key: string]: Id; }; register: (id: Id, component: React.ComponentType | undefined>, allowOverride?: boolean) => void; }" + ], "source": { "path": "src/plugins/advanced_settings/public/types.ts", "lineNumber": 16 }, - "signature": [ - "{ componentType: { [key: string]: Id; }; register: (id: Id, component: React.ComponentType | undefined>, allowOverride?: boolean) => void; }" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/advanced_settings/public/types.ts", - "lineNumber": 15 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "advancedSettings", "id": "def-public.AdvancedSettingsStart", "type": "Interface", + "tags": [], "label": "AdvancedSettingsStart", "description": [], - "tags": [], + "source": { + "path": "src/plugins/advanced_settings/public/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "advancedSettings", "id": "def-public.AdvancedSettingsStart.component", "type": "Object", + "tags": [], "label": "component", "description": [], + "signature": [ + "{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType | undefined>; }" + ], "source": { "path": "src/plugins/advanced_settings/public/types.ts", "lineNumber": 19 }, - "signature": [ - "{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType | undefined>; }" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/advanced_settings/public/types.ts", - "lineNumber": 18 - }, "lifecycle": "start", "initialIsOpen": true } diff --git a/api_docs/alerting.json b/api_docs/alerting.json index 803047ef9237d..cbe045a4981a0 100644 --- a/api_docs/alerting.json +++ b/api_docs/alerting.json @@ -8,69 +8,78 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "alerting", "id": "def-public.PluginSetupContract", "type": "Interface", + "tags": [], "label": "PluginSetupContract", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerNavigation", "type": "Function", + "tags": [], "label": "registerNavigation", "description": [], - "source": { - "path": "x-pack/plugins/alerting/public/plugin.ts", - "lineNumber": 15 - }, "signature": [ "(consumer: string, alertType: string, handler: ", "AlertNavigationHandler", ") => void" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 15 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerDefaultNavigation", "type": "Function", + "tags": [], "label": "registerDefaultNavigation", "description": [], - "source": { - "path": "x-pack/plugins/alerting/public/plugin.ts", - "lineNumber": 20 - }, "signature": [ "(consumer: string, handler: ", "AlertNavigationHandler", ") => void" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 20 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/public/plugin.ts", - "lineNumber": 14 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "alerting", "id": "def-public.PluginStartContract", "type": "Interface", + "tags": [], "label": "PluginStartContract", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-public.PluginStartContract.getNavigation", "type": "Function", + "tags": [], "label": "getNavigation", "description": [], - "source": { - "path": "x-pack/plugins/alerting/public/plugin.ts", - "lineNumber": 23 - }, "signature": [ "(alertId: string) => Promise<", { @@ -89,13 +98,14 @@ "text": "AlertStateNavigation" }, " | undefined>" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 23 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/public/plugin.ts", - "lineNumber": 22 - }, "lifecycle": "start", "initialIsOpen": true } @@ -104,43 +114,90 @@ "classes": [], "functions": [ { + "parentPluginId": "alerting", + "id": "def-server.getEsErrorMessage", + "type": "Function", + "tags": [], + "label": "getEsErrorMessage", + "description": [], + "signature": [ + "(error: ", + "ElasticsearchError", + ") => string" + ], + "source": { + "path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts", + "lineNumber": 37 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.getEsErrorMessage.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "ElasticsearchError" + ], + "source": { + "path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts", + "lineNumber": 37 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", "id": "def-server.parseDuration", "type": "Function", + "tags": [], "label": "parseDuration", + "description": [], "signature": [ "(duration: string) => number" ], - "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-server.parseDuration.$1", "type": "string", + "tags": [], "label": "duration", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 14 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "alerting", "id": "def-server.ActionGroup", "type": "Interface", + "tags": [], "label": "ActionGroup", + "description": [], "signature": [ { "pluginId": "alerting", @@ -151,45 +208,51 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.ActionGroup.id", "type": "Uncategorized", + "tags": [], "label": "id", "description": [], + "signature": [ + "ActionGroupIds" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 26 }, - "signature": [ - "ActionGroupIds" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.ActionGroup.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 27 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions", "type": "Interface", + "tags": [], "label": "AlertExecutorOptions", + "description": [], "signature": [ { "pluginId": "alerting", @@ -200,58 +263,64 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 79 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.alertId", "type": "string", + "tags": [], "label": "alertId", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 85 - } + "lineNumber": 86 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.startedAt", "type": "Object", + "tags": [], "label": "startedAt", "description": [], + "signature": [ + "Date" + ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 86 + "lineNumber": 87 }, - "signature": [ - "Date" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.previousStartedAt", "type": "CompoundType", + "tags": [], "label": "previousStartedAt", "description": [], + "signature": [ + "Date | null" + ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 87 + "lineNumber": 88 }, - "signature": [ - "Date | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.services", "type": "Object", + "tags": [], "label": "services", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 88 - }, "signature": [ { "pluginId": "alerting", @@ -261,140 +330,158 @@ "text": "AlertServices" }, "" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 89 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.params", "type": "Uncategorized", + "tags": [], "label": "params", "description": [], + "signature": [ + "Params" + ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 89 + "lineNumber": 90 }, - "signature": [ - "Params" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.state", "type": "Uncategorized", + "tags": [], "label": "state", "description": [], + "signature": [ + "State" + ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 90 + "lineNumber": 91 }, - "signature": [ - "State" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.spaceId", "type": "string", + "tags": [], "label": "spaceId", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 91 - } + "lineNumber": 92 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 92 + "lineNumber": 93 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 93 - } + "lineNumber": 94 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.tags", "type": "Array", + "tags": [], "label": "tags", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 94 + "lineNumber": 95 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.createdBy", "type": "CompoundType", + "tags": [], "label": "createdBy", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 95 + "lineNumber": 96 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.updatedBy", "type": "CompoundType", + "tags": [], "label": "updatedBy", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 96 + "lineNumber": 97 }, - "signature": [ - "string | null" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 78 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertingApiRequestHandlerContext", "type": "Interface", + "tags": [], "label": "AlertingApiRequestHandlerContext", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertingApiRequestHandlerContext.getAlertsClient", "type": "Function", + "tags": [], "label": "getAlertsClient", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 46 - }, "signature": [ "() => ", { @@ -404,34 +491,38 @@ "section": "def-server.AlertsClient", "text": "AlertsClient" } - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 46 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertingApiRequestHandlerContext.listTypes", "type": "Function", + "tags": [], "label": "listTypes", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 47 - }, "signature": [ "() => Set<", "RegistryAlertType", ">" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 47 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertingApiRequestHandlerContext.getFrameworkHealth", "type": "Function", + "tags": [], "label": "getFrameworkHealth", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 48 - }, "signature": [ "() => Promise<", { @@ -442,32 +533,52 @@ "text": "AlertsHealth" }, ">" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 48 + }, + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.AlertingApiRequestHandlerContext.areApiKeysEnabled", + "type": "Function", + "tags": [], + "label": "areApiKeysEnabled", + "description": [], + "signature": [ + "() => Promise" + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 49 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 45 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertingPlugin", "type": "Interface", + "tags": [], "label": "AlertingPlugin", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 219 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertingPlugin.setup", "type": "Object", - "label": "setup", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 219 - }, + "tags": [], + "label": "setup", + "description": [], "signature": [ { "pluginId": "alerting", @@ -476,18 +587,20 @@ "section": "def-server.PluginSetupContract", "text": "PluginSetupContract" } - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 220 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertingPlugin.start", "type": "Object", + "tags": [], "label": "start", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 220 - }, "signature": [ { "pluginId": "alerting", @@ -496,19 +609,23 @@ "section": "def-server.PluginStartContract", "text": "PluginStartContract" } - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 221 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 218 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertServices", "type": "Interface", + "tags": [], "label": "AlertServices", + "description": [], "signature": [ { "pluginId": "alerting", @@ -520,36 +637,40 @@ " extends ", "Services" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertServices.alertInstanceFactory", "type": "Function", + "tags": [], "label": "alertInstanceFactory", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 73 - }, "signature": [ "(id: string) => Pick<", "AlertInstance", ", \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 74 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 68 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertType", "type": "Interface", + "tags": [], "label": "AlertType", + "description": [], "signature": [ { "pluginId": "alerting", @@ -560,57 +681,63 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 113 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertType.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 120 - } + "lineNumber": 121 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 121 - } + "lineNumber": 122 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertType.validate", "type": "Object", + "tags": [], "label": "validate", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 122 - }, "signature": [ "{ params?: ", "AlertTypeParamsValidator", " | undefined; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 123 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertType.actionGroups", "type": "Array", + "tags": [], "label": "actionGroups", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 125 - }, "signature": [ { "pluginId": "alerting", @@ -620,32 +747,36 @@ "text": "ActionGroup" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 126 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertType.defaultActionGroupId", "type": "Uncategorized", + "tags": [], "label": "defaultActionGroupId", "description": [], + "signature": [ + "ActionGroupIds" + ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 126 + "lineNumber": 127 }, - "signature": [ - "ActionGroupIds" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertType.recoveryActionGroup", "type": "Object", + "tags": [], "label": "recoveryActionGroup", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 127 - }, "signature": [ { "pluginId": "alerting", @@ -655,18 +786,20 @@ "text": "ActionGroup" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 128 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertType.executor", "type": "Function", + "tags": [], "label": "executor", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 128 - }, "signature": [ "ExecutorType", ">" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 129 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertType.producer", "type": "string", + "tags": [], "label": "producer", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 139 - } + "lineNumber": 140 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertType.actionVariables", "type": "Object", + "tags": [], "label": "actionVariables", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 140 - }, "signature": [ "{ context?: ", { @@ -727,33 +864,39 @@ "text": "ActionVariable" }, "[] | undefined; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 141 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.AlertType.minimumLicenseRequired", "type": "CompoundType", + "tags": [], "label": "minimumLicenseRequired", "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 145 + "lineNumber": 146 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 112 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.FindResult", "type": "Interface", + "tags": [], "label": "FindResult", + "description": [], "signature": [ { "pluginId": "alerting", @@ -764,52 +907,58 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", + "lineNumber": 132 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.FindResult.page", "type": "number", + "tags": [], "label": "page", "description": [], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", "lineNumber": 133 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.FindResult.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", "lineNumber": 134 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.FindResult.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", "lineNumber": 135 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.FindResult.data", "type": "Array", + "tags": [], "label": "data", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", - "lineNumber": 136 - }, "signature": [ "Pick<", { @@ -820,26 +969,36 @@ "text": "Alert" }, ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", + "lineNumber": 136 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", - "lineNumber": 132 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.PluginSetupContract", "type": "Interface", + "tags": [], "label": "PluginSetupContract", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 84 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-server.PluginSetupContract.registerType", "type": "Function", + "tags": [], "label": "registerType", + "description": [], "signature": [ " = Record, State extends Record = Record, InstanceState extends { [x: string]: unknown; } = { [x: string]: unknown; }, InstanceContext extends { [x: string]: unknown; } = { [x: string]: unknown; }, ActionGroupIds extends string = never, RecoveryActionGroupId extends string = never>(alertType: ", { @@ -851,13 +1010,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 85 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-server.PluginSetupContract.registerType.$1", "type": "Object", + "tags": [], "label": "alertType", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "alerting", @@ -868,54 +1033,57 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 93 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 85 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 84 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.PluginStartContract", "type": "Interface", + "tags": [], "label": "PluginStartContract", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.PluginStartContract.listTypes", "type": "Function", + "tags": [], "label": "listTypes", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 105 - }, "signature": [ "() => Set<", "RegistryAlertType", ">" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 105 + }, + "deprecated": false }, { + "parentPluginId": "alerting", "id": "def-server.PluginStartContract.getAlertsClientWithRequest", "type": "Function", + "tags": [], "label": "getAlertsClientWithRequest", + "description": [], "signature": [ "(request: ", { @@ -935,13 +1103,19 @@ }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"muteAll\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">" ], - "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 106 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-server.PluginStartContract.getAlertsClientWithRequest.$1", "type": "Object", + "tags": [], "label": "request", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -952,30 +1126,23 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 106 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 106 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-server.PluginStartContract.getFrameworkHealth", "type": "Function", + "tags": [], "label": "getFrameworkHealth", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 107 - }, "signature": [ "() => Promise<", { @@ -986,88 +1153,94 @@ "text": "AlertsHealth" }, ">" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 107 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 104 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "alerting", "id": "def-server.ActionGroupIdsOf", "type": "Type", - "label": "ActionGroupIdsOf", "tags": [], + "label": "ActionGroupIdsOf", "description": [], + "signature": [ + "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 30 }, - "signature": [ - "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertActionParams", "type": "Type", - "label": "AlertActionParams", "tags": [], + "label": "AlertActionParams", "description": [], + "signature": [ + "SavedObjectAttributes" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 40 }, - "signature": [ - "SavedObjectAttributes" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertInstanceContext", "type": "Type", - "label": "AlertInstanceContext", "tags": [], + "label": "AlertInstanceContext", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_instance.ts", - "lineNumber": 28 - }, "signature": [ "{ [x: string]: unknown; }" ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance.ts", + "lineNumber": 28 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertInstanceState", "type": "Type", - "label": "AlertInstanceState", "tags": [], + "label": "AlertInstanceState", "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 25 }, - "signature": [ - "{ [x: string]: unknown; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertsClient", "type": "Type", - "label": "AlertsClient", "tags": [], + "label": "AlertsClient", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/index.ts", - "lineNumber": 15 - }, "signature": [ "{ get: ({ id, }: { id: string; }) => Promise, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>" ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 179 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.PublicAlertInstance", "type": "Type", - "label": "PublicAlertInstance", "tags": [], + "label": "PublicAlertInstance", "description": [], + "signature": [ + "{ getState: () => State; replaceState: (state: State) => AlertInstance; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => AlertInstance; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => AlertInstance; }" + ], "source": { "path": "x-pack/plugins/alerting/server/alert_instance/alert_instance.ts", "lineNumber": 30 }, - "signature": [ - "{ getState: () => State; replaceState: (state: State) => AlertInstance; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => AlertInstance; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => AlertInstance; }" - ], + "deprecated": false, "initialIsOpen": false } ], @@ -1167,9 +1353,12 @@ "classes": [], "functions": [ { + "parentPluginId": "alerting", "id": "def-common.getBuiltinActionGroups", "type": "Function", + "tags": [], "label": "getBuiltinActionGroups", + "description": [], "signature": [ "(customRecoveryGroup: ", { @@ -1197,13 +1386,19 @@ }, ">]" ], - "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-common.getBuiltinActionGroups.$1", "type": "Object", + "tags": [], "label": "customRecoveryGroup", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "alerting", @@ -1214,233 +1409,265 @@ }, " | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.getDurationNumberInItsUnit", "type": "Function", + "tags": [], "label": "getDurationNumberInItsUnit", + "description": [], "signature": [ "(duration: string) => number" ], - "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-common.getDurationNumberInItsUnit.$1", "type": "string", + "tags": [], "label": "duration", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.getDurationUnitValue", "type": "Function", + "tags": [], "label": "getDurationUnitValue", + "description": [], "signature": [ "(duration: string) => string" ], - "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-common.getDurationUnitValue.$1", "type": "string", + "tags": [], "label": "duration", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.isActionGroupDisabledForActionTypeId", "type": "Function", + "tags": [], "label": "isActionGroupDisabledForActionTypeId", + "description": [], "signature": [ "(actionGroup: string, actionTypeId: string) => boolean" ], - "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-common.isActionGroupDisabledForActionTypeId.$1", "type": "string", + "tags": [], "label": "actionGroup", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "alerting", "id": "def-common.isActionGroupDisabledForActionTypeId.$2", "type": "string", + "tags": [], "label": "actionTypeId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.parseDuration", "type": "Function", + "tags": [], "label": "parseDuration", + "description": [], "signature": [ "(duration: string) => number" ], - "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-common.parseDuration.$1", "type": "string", + "tags": [], "label": "duration", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.validateDurationSchema", "type": "Function", + "tags": [], "label": "validateDurationSchema", + "description": [], "signature": [ "(duration: string) => string | undefined" ], - "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-common.validateDurationSchema.$1", "type": "string", + "tags": [], "label": "duration", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 39 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.validateNotifyWhenType", "type": "Function", + "tags": [], "label": "validateNotifyWhenType", + "description": [], "signature": [ "(notifyWhen: string) => string | undefined" ], - "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "alerting", "id": "def-common.validateNotifyWhenType.$1", "type": "string", + "tags": [], "label": "notifyWhen", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", - "lineNumber": 15 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "alerting", "id": "def-common.ActionGroup", "type": "Interface", + "tags": [], "label": "ActionGroup", + "description": [], "signature": [ { "pluginId": "alerting", @@ -1451,109 +1678,125 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.ActionGroup.id", "type": "Uncategorized", + "tags": [], "label": "id", "description": [], + "signature": [ + "ActionGroupIds" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 26 }, - "signature": [ - "ActionGroupIds" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.ActionGroup.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 27 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.ActionVariable", "type": "Interface", + "tags": [], "label": "ActionVariable", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 101 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.ActionVariable.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 102 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.ActionVariable.description", "type": "string", + "tags": [], "label": "description", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 103 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.ActionVariable.deprecated", "type": "CompoundType", + "tags": [], "label": "deprecated", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 104 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.ActionVariable.useWithTripleBracesInTemplates", "type": "CompoundType", + "tags": [], "label": "useWithTripleBracesInTemplates", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 105 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 101 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.Alert", "type": "Interface", + "tags": [], "label": "Alert", + "description": [], "signature": [ { "pluginId": "alerting", @@ -1564,88 +1807,100 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.enabled", "type": "boolean", + "tags": [], "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 56 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.tags", "type": "Array", + "tags": [], "label": "tags", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 58 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.alertTypeId", "type": "string", + "tags": [], "label": "alertTypeId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 59 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.consumer", "type": "string", + "tags": [], "label": "consumer", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 60 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.schedule", "type": "Object", - "label": "schedule", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 61 - }, + "tags": [], + "label": "schedule", + "description": [], "signature": [ { "pluginId": "alerting", @@ -1654,18 +1909,20 @@ "section": "def-common.IntervalSchedule", "text": "IntervalSchedule" } - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 61 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.actions", "type": "Array", + "tags": [], "label": "actions", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 62 - }, "signature": [ { "pluginId": "alerting", @@ -1675,183 +1932,209 @@ "text": "AlertAction" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 62 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.params", "type": "Uncategorized", + "tags": [], "label": "params", "description": [], + "signature": [ + "Params" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 63 }, - "signature": [ - "Params" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.scheduledTaskId", "type": "string", + "tags": [], "label": "scheduledTaskId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 64 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.createdBy", "type": "CompoundType", + "tags": [], "label": "createdBy", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 65 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.updatedBy", "type": "CompoundType", + "tags": [], "label": "updatedBy", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 66 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.createdAt", "type": "Object", + "tags": [], "label": "createdAt", "description": [], + "signature": [ + "Date" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 67 }, - "signature": [ - "Date" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.updatedAt", "type": "Object", + "tags": [], "label": "updatedAt", "description": [], + "signature": [ + "Date" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 68 }, - "signature": [ - "Date" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.apiKey", "type": "CompoundType", + "tags": [], "label": "apiKey", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 69 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.apiKeyOwner", "type": "CompoundType", + "tags": [], "label": "apiKeyOwner", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 70 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.throttle", "type": "CompoundType", + "tags": [], "label": "throttle", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 71 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.notifyWhen", "type": "CompoundType", + "tags": [], "label": "notifyWhen", "description": [], + "signature": [ + "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 72 }, - "signature": [ - "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.muteAll", "type": "boolean", + "tags": [], "label": "muteAll", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 73 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.mutedInstanceIds", "type": "Array", + "tags": [], "label": "mutedInstanceIds", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 74 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.Alert.executionStatus", "type": "Object", + "tags": [], "label": "executionStatus", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 75 - }, "signature": [ { "pluginId": "alerting", @@ -1860,149 +2143,171 @@ "section": "def-common.AlertExecutionStatus", "text": "AlertExecutionStatus" } - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 75 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertAction", "type": "Interface", + "tags": [], "label": "AlertAction", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertAction.group", "type": "string", + "tags": [], "label": "group", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 44 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertAction.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 45 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertAction.actionTypeId", "type": "string", + "tags": [], "label": "actionTypeId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 46 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertAction.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "SavedObjectAttributes" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 47 }, - "signature": [ - "SavedObjectAttributes" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 43 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertAggregations", "type": "Interface", + "tags": [], "label": "AlertAggregations", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertAggregations.alertExecutionStatus", "type": "Object", + "tags": [], "label": "alertExecutionStatus", "description": [], + "signature": [ + "{ [status: string]: number; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 51 }, - "signature": [ - "{ [status: string]: number; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 50 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatus", "type": "Interface", + "tags": [], "label": "AlertExecutionStatus", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatus.status", "type": "CompoundType", + "tags": [], "label": "status", "description": [], + "signature": [ + "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 32 }, - "signature": [ - "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatus.lastExecutionDate", "type": "Object", + "tags": [], "label": "lastExecutionDate", "description": [], + "signature": [ + "Date" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 33 }, - "signature": [ - "Date" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatus.error", "type": "Object", + "tags": [], "label": "error", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 34 - }, "signature": [ "{ reason: ", { @@ -2013,54 +2318,62 @@ "text": "AlertExecutionStatusErrorReasons" }, "; message: string; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 34 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertingFrameworkHealth", "type": "Interface", + "tags": [], "label": "AlertingFrameworkHealth", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/index.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertingFrameworkHealth.isSufficientlySecure", "type": "boolean", + "tags": [], "label": "isSufficientlySecure", "description": [], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey", "type": "boolean", + "tags": [], "label": "hasPermanentEncryptionKey", "description": [], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertingFrameworkHealth.alertingFrameworkHeath", "type": "Object", + "tags": [], "label": "alertingFrameworkHeath", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/index.ts", - "lineNumber": 24 - }, "signature": [ { "pluginId": "alerting", @@ -2069,32 +2382,36 @@ "section": "def-common.AlertsHealth", "text": "AlertsHealth" } - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/index.ts", + "lineNumber": 24 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/index.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus", "type": "Interface", + "tags": [], "label": "AlertInstanceStatus", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus.status", "type": "CompoundType", + "tags": [], "label": "status", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 29 - }, "signature": [ { "pluginId": "alerting", @@ -2103,201 +2420,233 @@ "section": "def-common.AlertInstanceStatusValues", "text": "AlertInstanceStatusValues" } - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus.muted", "type": "boolean", + "tags": [], "label": "muted", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus.actionGroupId", "type": "string", + "tags": [], "label": "actionGroupId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 31 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus.actionSubgroup", "type": "string", + "tags": [], "label": "actionSubgroup", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 32 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus.activeStartDate", "type": "string", + "tags": [], "label": "activeStartDate", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 33 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary", "type": "Interface", + "tags": [], "label": "AlertInstanceSummary", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.tags", "type": "Array", + "tags": [], "label": "tags", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 14 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.alertTypeId", "type": "string", + "tags": [], "label": "alertTypeId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.consumer", "type": "string", + "tags": [], "label": "consumer", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.muteAll", "type": "boolean", + "tags": [], "label": "muteAll", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.throttle", "type": "CompoundType", + "tags": [], "label": "throttle", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 18 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.enabled", "type": "boolean", + "tags": [], "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.statusStartDate", "type": "string", + "tags": [], "label": "statusStartDate", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.statusEndDate", "type": "string", + "tags": [], "label": "statusEndDate", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.status", "type": "CompoundType", + "tags": [], "label": "status", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 22 - }, "signature": [ { "pluginId": "alerting", @@ -2306,46 +2655,52 @@ "section": "def-common.AlertStatusValues", "text": "AlertStatusValues" } - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 22 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.lastRun", "type": "string", + "tags": [], "label": "lastRun", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 23 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.errorMessages", "type": "Array", + "tags": [], "label": "errorMessages", "description": [], + "signature": [ + "{ date: string; message: string; }[]" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 24 }, - "signature": [ - "{ date: string; message: string; }[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.instances", "type": "Object", + "tags": [], "label": "instances", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 25 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 25 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertsHealth", "type": "Interface", + "tags": [], "label": "AlertsHealth", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertsHealth.decryptionHealth", "type": "Object", + "tags": [], "label": "decryptionHealth", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 87 - }, "signature": [ "{ status: ", { @@ -2392,18 +2751,20 @@ "text": "HealthStatus" }, "; timestamp: string; }" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 87 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertsHealth.executionHealth", "type": "Object", + "tags": [], "label": "executionHealth", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 91 - }, "signature": [ "{ status: ", { @@ -2414,18 +2775,20 @@ "text": "HealthStatus" }, "; timestamp: string; }" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 91 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertsHealth.readHealth", "type": "Object", + "tags": [], "label": "readHealth", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 95 - }, "signature": [ "{ status: ", { @@ -2436,32 +2799,36 @@ "text": "HealthStatus" }, "; timestamp: string; }" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 95 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 86 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertStateNavigation", "type": "Interface", + "tags": [], "label": "AlertStateNavigation", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_navigation.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertStateNavigation.state", "type": "Object", + "tags": [], "label": "state", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_navigation.ts", - "lineNumber": 14 - }, "signature": [ { "pluginId": "kibanaUtils", @@ -2470,19 +2837,23 @@ "section": "def-common.JsonObject", "text": "JsonObject" } - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_navigation.ts", + "lineNumber": 14 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert_navigation.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertType", "type": "Interface", + "tags": [], "label": "AlertType", + "description": [], "signature": [ { "pluginId": "alerting", @@ -2493,41 +2864,45 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertType.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertType.actionGroups", "type": "Array", + "tags": [], "label": "actionGroups", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 17 - }, "signature": [ { "pluginId": "alerting", @@ -2537,18 +2912,20 @@ "text": "ActionGroup" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertType.recoveryActionGroup", "type": "Object", + "tags": [], "label": "recoveryActionGroup", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "alerting", @@ -2558,97 +2935,113 @@ "text": "ActionGroup" }, "" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertType.actionVariables", "type": "Array", + "tags": [], "label": "actionVariables", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 19 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertType.defaultActionGroupId", "type": "Uncategorized", + "tags": [], "label": "defaultActionGroupId", "description": [], + "signature": [ + "ActionGroupIds" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 20 }, - "signature": [ - "ActionGroupIds" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertType.producer", "type": "string", + "tags": [], "label": "producer", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertType.minimumLicenseRequired", "type": "CompoundType", + "tags": [], "label": "minimumLicenseRequired", "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 22 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertUrlNavigation", "type": "Interface", + "tags": [], "label": "AlertUrlNavigation", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_navigation.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertUrlNavigation.path", "type": "string", + "tags": [], "label": "path", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "lineNumber": 11 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert_navigation.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.IntervalSchedule", "type": "Interface", + "tags": [], "label": "IntervalSchedule", + "description": [], "signature": [ { "pluginId": "alerting", @@ -2660,80 +3053,84 @@ " extends ", "SavedObjectAttributes" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.IntervalSchedule.interval", "type": "string", + "tags": [], "label": "interval", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 15 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 14 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatusErrorReasons", "type": "Enum", - "label": "AlertExecutionStatusErrorReasons", "tags": [], + "label": "AlertExecutionStatusErrorReasons", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 23 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.HealthStatus", "type": "Enum", - "label": "HealthStatus", "tags": [], + "label": "HealthStatus", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 80 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "alerting", "id": "def-common.ActionGroupIdsOf", "type": "Type", - "label": "ActionGroupIdsOf", "tags": [], + "label": "ActionGroupIdsOf", "description": [], + "signature": [ + "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 30 }, - "signature": [ - "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertActionParam", "type": "Type", - "label": "AlertActionParam", "tags": [], + "label": "AlertActionParam", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 41 - }, "signature": [ "undefined | null | string | number | false | true | ", "SavedObjectAttributes", @@ -2741,108 +3138,122 @@ "SavedObjectAttributeSingle", "[]" ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 41 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertActionParams", "type": "Type", - "label": "AlertActionParams", "tags": [], + "label": "AlertActionParams", "description": [], + "signature": [ + "SavedObjectAttributes" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 40 }, - "signature": [ - "SavedObjectAttributes" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatuses", "type": "Type", - "label": "AlertExecutionStatuses", "tags": [], + "label": "AlertExecutionStatuses", "description": [], + "signature": [ + "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 21 }, - "signature": [ - "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertInstanceContext", "type": "Type", - "label": "AlertInstanceContext", "tags": [], + "label": "AlertInstanceContext", "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 28 }, - "signature": [ - "{ [x: string]: unknown; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertInstanceMeta", "type": "Type", - "label": "AlertInstanceMeta", "tags": [], + "label": "AlertInstanceMeta", "description": [], + "signature": [ + "{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 22 }, - "signature": [ - "{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertInstanceState", "type": "Type", - "label": "AlertInstanceState", "tags": [], + "label": "AlertInstanceState", "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 25 }, - "signature": [ - "{ [x: string]: unknown; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatusValues", "type": "Type", - "label": "AlertInstanceStatusValues", "tags": [], + "label": "AlertInstanceStatusValues", "description": [], + "signature": [ + "\"OK\" | \"Active\"" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 9 }, - "signature": [ - "\"OK\" | \"Active\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertNavigation", "type": "Type", - "label": "AlertNavigation", "tags": [], + "label": "AlertNavigation", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_navigation.ts", - "lineNumber": 16 - }, "signature": [ { "pluginId": "alerting", @@ -2860,275 +3271,311 @@ "text": "AlertStateNavigation" } ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_navigation.ts", + "lineNumber": 16 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertNotifyWhenType", "type": "Type", - "label": "AlertNotifyWhenType", "tags": [], + "label": "AlertNotifyWhenType", "description": [], + "signature": [ + "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", "lineNumber": 13 }, - "signature": [ - "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.ALERTS_FEATURE_ID", "type": "string", + "tags": [], "label": "ALERTS_FEATURE_ID", "description": [], + "signature": [ + "\"alerts\"" + ], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 30 }, - "signature": [ - "\"alerts\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertStatusValues", "type": "Type", - "label": "AlertStatusValues", "tags": [], + "label": "AlertStatusValues", "description": [], + "signature": [ + "\"OK\" | \"Active\" | \"Error\"" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 8 }, - "signature": [ - "\"OK\" | \"Active\" | \"Error\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertTaskParams", "type": "Type", - "label": "AlertTaskParams", "tags": [], + "label": "AlertTaskParams", "description": [], + "signature": [ + "{ alertId: string; } & { spaceId?: string | undefined; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", "lineNumber": 28 }, - "signature": [ - "{ alertId: string; } & { spaceId?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertTaskState", "type": "Type", - "label": "AlertTaskState", "tags": [], + "label": "AlertTaskState", "description": [], + "signature": [ + "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", "lineNumber": 18 }, - "signature": [ - "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertTypeParams", "type": "Type", - "label": "AlertTypeParams", "tags": [], + "label": "AlertTypeParams", "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 12 }, - "signature": [ - "{ [x: string]: unknown; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.AlertTypeState", "type": "Type", - "label": "AlertTypeState", "tags": [], + "label": "AlertTypeState", "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 11 }, - "signature": [ - "{ [x: string]: unknown; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.BASE_ALERTING_API_PATH", "type": "string", + "tags": [], "label": "BASE_ALERTING_API_PATH", "description": [], + "signature": [ + "\"/api/alerting\"" + ], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 28 }, - "signature": [ - "\"/api/alerting\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.DefaultActionGroupId", "type": "Type", - "label": "DefaultActionGroupId", "tags": [], + "label": "DefaultActionGroupId", "description": [], + "signature": [ + "\"default\"" + ], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 11 }, - "signature": [ - "\"default\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.INTERNAL_BASE_ALERTING_API_PATH", "type": "string", + "tags": [], "label": "INTERNAL_BASE_ALERTING_API_PATH", "description": [], + "signature": [ + "\"/internal/alerting\"" + ], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 29 }, - "signature": [ - "\"/internal/alerting\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.LEGACY_BASE_ALERT_API_PATH", "type": "string", + "tags": [], "label": "LEGACY_BASE_ALERT_API_PATH", "description": [], + "signature": [ + "\"/api/alerts\"" + ], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 27 }, - "signature": [ - "\"/api/alerts\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.RawAlertInstance", "type": "Type", - "label": "RawAlertInstance", "tags": [], + "label": "RawAlertInstance", "description": [], + "signature": [ + "{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 34 }, - "signature": [ - "{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.RecoveredActionGroupId", "type": "Type", - "label": "RecoveredActionGroupId", "tags": [], + "label": "RecoveredActionGroupId", "description": [], + "signature": [ + "\"recovered\"" + ], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 13 }, - "signature": [ - "\"recovered\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.ReservedActionGroups", "type": "Type", - "label": "ReservedActionGroups", "tags": [], + "label": "ReservedActionGroups", "description": [], + "signature": [ + "RecoveryActionGroupId | \"recovered\"" + ], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 21 }, - "signature": [ - "RecoveryActionGroupId | \"recovered\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.SanitizedAlert", "type": "Type", - "label": "SanitizedAlert", "tags": [], + "label": "SanitizedAlert", "description": [], + "signature": [ + "{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; tags: string[]; muteAll: boolean; alertTypeId: string; consumer: string; schedule: IntervalSchedule; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: AlertExecutionStatus; }" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 78 }, - "signature": [ - "{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; tags: string[]; muteAll: boolean; alertTypeId: string; consumer: string; schedule: IntervalSchedule; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: AlertExecutionStatus; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-common.WithoutReservedActionGroups", "type": "Type", - "label": "WithoutReservedActionGroups", "tags": [], + "label": "WithoutReservedActionGroups", "description": [], + "signature": [ + "ActionGroupIds extends ReservedActionGroups ? never : ActionGroupIds" + ], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 25 }, - "signature": [ - "ActionGroupIds extends ReservedActionGroups ? never : ActionGroupIds" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatusValues", "type": "Object", + "tags": [], "label": "AlertExecutionStatusValues", "description": [], + "signature": [ + "readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\"]" + ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 20 }, - "signature": [ - "readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\"]" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.alertParamsSchema", "type": "Object", + "tags": [], "label": "alertParamsSchema", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", - "lineNumber": 20 - }, "signature": [ "IntersectionC", "<[", @@ -3140,18 +3587,20 @@ "<{ spaceId: ", "StringC" ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.alertStateSchema", "type": "Object", + "tags": [], "label": "alertStateSchema", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", - "lineNumber": 12 - }, "signature": [ "PartialC", "<{ alertTypeState: ", @@ -3163,33 +3612,37 @@ ">; alertInstances: ", "RecordC" ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", + "lineNumber": 12 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.DisabledActionTypeIdsForActionGroup", "type": "Object", + "tags": [], "label": "DisabledActionTypeIdsForActionGroup", "description": [], + "signature": [ + "Map" + ], "source": { "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "lineNumber": 14 }, - "signature": [ - "Map" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.rawAlertInstance", "type": "Object", + "tags": [], "label": "rawAlertInstance", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_instance.ts", - "lineNumber": 30 - }, "signature": [ "PartialC", "<{ state: ", @@ -3201,18 +3654,20 @@ ">; meta: ", "PartialC" ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance.ts", + "lineNumber": 30 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "alerting", "id": "def-common.RecoveredActionGroup", "type": "Object", + "tags": [], "label": "RecoveredActionGroup", "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", - "lineNumber": 14 - }, "signature": [ "Readonly<", { @@ -3224,6 +3679,11 @@ }, "<\"recovered\">>" ], + "source": { + "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", + "lineNumber": 14 + }, + "deprecated": false, "initialIsOpen": false } ] diff --git a/api_docs/apm.json b/api_docs/apm.json index e3d8747d7b465..611bf6f455ec5 100644 --- a/api_docs/apm.json +++ b/api_docs/apm.json @@ -5,72 +5,100 @@ "functions": [], "interfaces": [ { + "parentPluginId": "apm", "id": "def-public.ConfigSchema", "type": "Interface", + "tags": [], "label": "ConfigSchema", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/apm/public/index.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "apm", "id": "def-public.ConfigSchema.serviceMapEnabled", "type": "boolean", + "tags": [], "label": "serviceMapEnabled", "description": [], "source": { "path": "x-pack/plugins/apm/public/index.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "apm", "id": "def-public.ConfigSchema.profilingEnabled", "type": "boolean", + "tags": [], "label": "profilingEnabled", "description": [], "source": { "path": "x-pack/plugins/apm/public/index.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "apm", "id": "def-public.ConfigSchema.ui", "type": "Object", + "tags": [], "label": "ui", "description": [], + "signature": [ + "{ enabled: boolean; }" + ], "source": { "path": "x-pack/plugins/apm/public/index.ts", "lineNumber": 17 }, - "signature": [ - "{ enabled: boolean; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/apm/public/index.ts", - "lineNumber": 14 - }, "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], - "start": { - "id": "def-public.ApmPluginStart", + "setup": { + "parentPluginId": "apm", + "id": "def-public.ApmPluginSetup", "type": "Type", - "label": "ApmPluginStart", "tags": [], + "label": "ApmPluginSetup", "description": [], + "signature": [ + "{ ruleRegistry: FormatterRuleRegistry<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { 'kibana.observability.evaluation.value': { type: \"scaled_float\"; scaling_factor: number; }; 'kibana.observability.evaluation.threshold': { type: \"scaled_float\"; scaling_factor: number; }; 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { readonly 'service.environment': { readonly type: \"keyword\"; }; readonly 'transaction.type': { readonly type: \"keyword\"; }; readonly 'processor.event': { readonly type: \"keyword\"; }; }>; }" + ], "source": { "path": "x-pack/plugins/apm/public/plugin.ts", - "lineNumber": 45 + "lineNumber": 48 }, + "deprecated": false, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "apm", + "id": "def-public.ApmPluginStart", + "type": "Type", + "tags": [], + "label": "ApmPluginStart", + "description": [], "signature": [ "void" ], + "source": { + "path": "x-pack/plugins/apm/public/plugin.ts", + "lineNumber": 51 + }, + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -78,6 +106,7 @@ "server": { "classes": [ { + "parentPluginId": "apm", "id": "def-server.APMPlugin", "type": "Class", "tags": [], @@ -112,21 +141,35 @@ ", ", "APMPluginStartDependencies" ], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apm", "id": "def-server.APMPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apm", "id": "def-server.APMPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -137,24 +180,23 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 58 - } + "lineNumber": 60 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 58 - } + "returnComment": [] }, { + "parentPluginId": "apm", "id": "def-server.APMPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -168,18 +210,24 @@ "APMPluginStartDependencies", ", unknown>, plugins: Pick<", "APMPluginSetupDependencies", - ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"spaces\" | \"cloud\" | \"taskManager\" | \"alerting\">) => { config$: ", + ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"cloud\" | \"observability\" | \"apmOss\" | \"licensing\" | \"spaces\" | \"taskManager\" | \"alerting\">) => { config$: ", "Observable", "<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ", "SearchAggregatedTransactionSetting" ], - "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apm", "id": "def-server.APMPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -192,40 +240,42 @@ "APMPluginStartDependencies", ", unknown>" ], - "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 63 - } + "lineNumber": 65 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apm", "id": "def-server.APMPlugin.setup.$2", "type": "Object", + "tags": [], "label": "plugins", - "isRequired": true, + "description": [], "signature": [ "Pick<", "APMPluginSetupDependencies", - ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"spaces\" | \"cloud\" | \"taskManager\" | \"alerting\">" + ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"cloud\" | \"observability\" | \"apmOss\" | \"licensing\" | \"spaces\" | \"taskManager\" | \"alerting\">" ], - "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 64 - } + "lineNumber": 66 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 62 - } + "returnComment": [] }, { + "parentPluginId": "apm", "id": "def-server.APMPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -237,13 +287,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 200 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apm", "id": "def-server.APMPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -253,49 +309,46 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 208 - } + "lineNumber": 200 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 208 - } + "returnComment": [] }, { + "parentPluginId": "apm", "id": "def-server.APMPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 227 - } + "lineNumber": 219 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 48 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "apm", "id": "def-server.mergeConfigs", "type": "Function", + "tags": [], "label": "mergeConfigs", + "description": [], "signature": [ "(apmOssConfig: Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>, apmConfig: Readonly<{} & { enabled: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; autocreateApmIndexPattern: boolean; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", @@ -303,66 +356,74 @@ "SearchAggregatedTransactionSetting", "; 'xpack.apm.metricsInterval': number; }" ], - "description": [], + "source": { + "path": "x-pack/plugins/apm/server/index.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apm", "id": "def-server.mergeConfigs.$1", "type": "Object", + "tags": [], "label": "apmOssConfig", - "isRequired": true, + "description": [], "signature": [ "Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>" ], - "description": [], "source": { "path": "x-pack/plugins/apm/server/index.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apm", "id": "def-server.mergeConfigs.$2", "type": "Object", + "tags": [], "label": "apmConfig", - "isRequired": true, + "description": [], "signature": [ "Readonly<{} & { enabled: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; autocreateApmIndexPattern: boolean; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", "; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>" ], - "description": [], "source": { "path": "x-pack/plugins/apm/server/index.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/apm/server/index.ts", - "lineNumber": 59 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "apm", "id": "def-server.APMRouteHandlerResources", "type": "Interface", + "tags": [], "label": "APMRouteHandlerResources", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "apm", "id": "def-server.APMRouteHandlerResources.request", "type": "Object", + "tags": [], "label": "request", "description": [], - "source": { - "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 43 - }, "signature": [ { "pluginId": "core", @@ -372,76 +433,86 @@ "text": "KibanaRequest" }, "" - ] + ], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 46 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "apm", "id": "def-server.APMRouteHandlerResources.context", "type": "Object", + "tags": [], "label": "context", "description": [], + "signature": [ + "ApmPluginRequestHandlerContext" + ], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 44 + "lineNumber": 47 }, - "signature": [ - "ApmPluginRequestHandlerContext" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "apm", "id": "def-server.APMRouteHandlerResources.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ query: { _inspect: boolean; }; }" + ], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 45 + "lineNumber": 48 }, - "signature": [ - "{ query: { _inspect: boolean; }; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "apm", "id": "def-server.APMRouteHandlerResources.config", "type": "Object", + "tags": [], "label": "config", "description": [], - "source": { - "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 50 - }, "signature": [ "{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ", "SearchAggregatedTransactionSetting", "; 'xpack.apm.metricsInterval': number; }" - ] + ], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 53 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "apm", "id": "def-server.APMRouteHandlerResources.logger", "type": "Object", + "tags": [], "label": "logger", "description": [], + "signature": [ + "Logger" + ], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 51 + "lineNumber": 54 }, - "signature": [ - "Logger" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "apm", "id": "def-server.APMRouteHandlerResources.core", "type": "Object", + "tags": [], "label": "core", "description": [], - "source": { - "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 52 - }, "signature": [ "{ setup: ", { @@ -460,18 +531,20 @@ "text": "CoreStart" }, ">; }" - ] + ], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "apm", "id": "def-server.APMRouteHandlerResources.plugins", "type": "Object", + "tags": [], "label": "plugins", "description": [], - "source": { - "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 56 - }, "signature": [ "{ data: { setup: ", { @@ -505,64 +578,83 @@ "section": "def-server.PluginStartContract", "text": "PluginStartContract" }, - ">; }; apmOss: { setup: ", + ">; }; observability: { setup: { getScopedAnnotationsClient: (requestContext: ", { - "pluginId": "apmOss", + "pluginId": "core", "scope": "server", - "docId": "kibApmOssPluginApi", - "section": "def-server.APMOSSPluginSetup", - "text": "APMOSSPluginSetup" + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" } - ] + ], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 59 + }, + "deprecated": false + }, + { + "parentPluginId": "apm", + "id": "def-server.APMRouteHandlerResources.apmRuleRegistry", + "type": "Object", + "tags": [], + "label": "apmRuleRegistry", + "description": [], + "signature": [ + "RuleRegistry", + "<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { 'kibana.observability.evaluation.value': { type: \"scaled_float\"; scaling_factor: number; }; 'kibana.observability.evaluation.threshold': { type: \"scaled_float\"; scaling_factor: number; }; 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { readonly 'service.environment': { readonly type: \"keyword\"; }; readonly 'transaction.type': { readonly type: \"keyword\"; }; readonly 'processor.event': { readonly type: \"keyword\"; }; }>" + ], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 65 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 42 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "apm", "id": "def-server.ProcessorEvent", "type": "Enum", - "label": "ProcessorEvent", "tags": [], + "label": "ProcessorEvent", "description": [], "source": { "path": "x-pack/plugins/apm/common/processor_event.ts", "lineNumber": 8 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "apm", "id": "def-server.APMConfig", "type": "Type", - "label": "APMConfig", "tags": [], + "label": "APMConfig", "description": [], + "signature": [ + "{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': SearchAggregatedTransactionSetting; 'xpack.apm.metricsInterval': number; }" + ], "source": { "path": "x-pack/plugins/apm/server/index.ts", "lineNumber": 56 }, - "signature": [ - "{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': SearchAggregatedTransactionSetting; 'xpack.apm.metricsInterval': number; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "apm", "id": "def-server.APMServerRouteRepository", "type": "Type", - "label": "APMServerRouteRepository", "tags": [], + "label": "APMServerRouteRepository", "description": [], - "source": { - "path": "x-pack/plugins/apm/server/routes/get_global_apm_server_route_repository.ts", - "lineNumber": 60 - }, "signature": [ "ServerRouteRepository; readonly searchAggregatedTransactions: SearchAggregatedTransactionSetting; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly maxServiceEnvironments: number; readonly maxServiceSelection: number; readonly profilingEnabled: boolean; }" + ], "source": { "path": "x-pack/plugins/apm/server/index.ts", "lineNumber": 55 }, - "signature": [ - "{ readonly enabled: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly autocreateApmIndexPattern: boolean; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: SearchAggregatedTransactionSetting; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly maxServiceEnvironments: number; readonly maxServiceSelection: number; readonly profilingEnabled: boolean; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "apm", "id": "def-server.InspectResponse", "type": "Type", - "label": "InspectResponse", "tags": [], + "label": "InspectResponse", "description": [], - "source": { - "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 23 - }, "signature": [ "{ response: any; duration: number; requestType: string; requestParams: Record; esError: Error; }[]" ], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 26 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "apm", "id": "def-server.APMPluginSetup", "type": "Interface", + "tags": [], "label": "APMPluginSetup", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "apm", "id": "def-server.APMPluginSetup.config$", "type": "Object", + "tags": [], "label": "config$", "description": [], - "source": { - "path": "x-pack/plugins/apm/server/types.ts", - "lineNumber": 48 - }, "signature": [ "Observable", "<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ", "SearchAggregatedTransactionSetting", "; 'xpack.apm.metricsInterval': number; }>" - ] + ], + "source": { + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 48 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "apm", "id": "def-server.APMPluginSetup.getApmIndices", "type": "Function", + "tags": [], "label": "getApmIndices", "description": [], - "source": { - "path": "x-pack/plugins/apm/server/types.ts", - "lineNumber": 49 - }, "signature": [ "() => Promise<", "ApmIndicesConfig", ">" - ] + ], + "source": { + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 49 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "apm", "id": "def-server.APMPluginSetup.createApmEventClient", "type": "Function", + "tags": [], "label": "createApmEventClient", "description": [], - "source": { - "path": "x-pack/plugins/apm/server/types.ts", - "lineNumber": 50 - }, "signature": [ "(params: { debug?: boolean | undefined; request: ", { @@ -676,13 +784,14 @@ "InferSearchResponseOf", " + ### Start diff --git a/api_docs/apm_oss.json b/api_docs/apm_oss.json index 69dc62ceff4c0..35fddcedb22d9 100644 --- a/api_docs/apm_oss.json +++ b/api_docs/apm_oss.json @@ -7,47 +7,53 @@ "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "apmOss", "id": "def-public.APM_STATIC_INDEX_PATTERN_ID", "type": "string", + "tags": [], "label": "APM_STATIC_INDEX_PATTERN_ID", "description": [], + "signature": [ + "\"apm_static_index_pattern_id\"" + ], "source": { "path": "src/plugins/apm_oss/common/index_pattern_constants.ts", "lineNumber": 9 }, - "signature": [ - "\"apm_static_index_pattern_id\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "apmOss", "id": "def-public.ApmOssPluginSetup", "type": "Interface", + "tags": [], "label": "ApmOssPluginSetup", "description": [], - "tags": [], - "children": [], "source": { "path": "src/plugins/apm_oss/public/types.ts", "lineNumber": 10 }, + "deprecated": false, + "children": [], "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "apmOss", "id": "def-public.ApmOssPluginStart", "type": "Interface", + "tags": [], "label": "ApmOssPluginStart", "description": [], - "tags": [], - "children": [], "source": { "path": "src/plugins/apm_oss/public/types.ts", "lineNumber": 13 }, + "deprecated": false, + "children": [], "lifecycle": "start", "initialIsOpen": true } @@ -56,448 +62,525 @@ "classes": [], "functions": [ { + "parentPluginId": "apmOss", "id": "def-server.createDjangoAgentInstructions", "type": "Function", + "tags": [], + "label": "createDjangoAgentInstructions", + "description": [], + "signature": [ + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + ], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 88 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apmOss", "id": "def-server.createDjangoAgentInstructions.$1", "type": "string", + "tags": [], "label": "apmServerUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 88 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apmOss", "id": "def-server.createDjangoAgentInstructions.$2", "type": "string", + "tags": [], "label": "secretToken", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 88 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "description": [], - "label": "createDjangoAgentInstructions", - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 88 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "apmOss", "id": "def-server.createDotNetAgentInstructions", "type": "Function", + "tags": [], + "label": "createDotNetAgentInstructions", + "description": [], + "signature": [ + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; commands: string[]; textPost: string; textPre?: undefined; })[]" + ], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 631 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apmOss", "id": "def-server.createDotNetAgentInstructions.$1", "type": "string", + "tags": [], "label": "apmServerUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 631 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apmOss", "id": "def-server.createDotNetAgentInstructions.$2", "type": "string", + "tags": [], "label": "secretToken", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 631 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; commands: string[]; textPost: string; textPre?: undefined; })[]" - ], - "description": [], - "label": "createDotNetAgentInstructions", - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 631 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "apmOss", "id": "def-server.createFlaskAgentInstructions", "type": "Function", + "tags": [], + "label": "createFlaskAgentInstructions", + "description": [], + "signature": [ + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + ], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 173 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apmOss", "id": "def-server.createFlaskAgentInstructions.$1", "type": "string", + "tags": [], "label": "apmServerUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 173 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apmOss", "id": "def-server.createFlaskAgentInstructions.$2", "type": "string", + "tags": [], "label": "secretToken", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 173 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "description": [], - "label": "createFlaskAgentInstructions", - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 173 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "apmOss", "id": "def-server.createGoAgentInstructions", "type": "Function", + "tags": [], + "label": "createGoAgentInstructions", + "description": [], + "signature": [ + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + ], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 492 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apmOss", "id": "def-server.createGoAgentInstructions.$1", "type": "string", + "tags": [], "label": "apmServerUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 492 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apmOss", "id": "def-server.createGoAgentInstructions.$2", "type": "string", + "tags": [], "label": "secretToken", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 492 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "description": [], - "label": "createGoAgentInstructions", - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 492 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "apmOss", "id": "def-server.createJavaAgentInstructions", "type": "Function", + "tags": [], + "label": "createJavaAgentInstructions", + "description": [], + "signature": [ + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + ], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 585 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apmOss", "id": "def-server.createJavaAgentInstructions.$1", "type": "string", + "tags": [], "label": "apmServerUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 585 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apmOss", "id": "def-server.createJavaAgentInstructions.$2", "type": "string", + "tags": [], "label": "secretToken", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 585 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "description": [], - "label": "createJavaAgentInstructions", - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 585 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "apmOss", "id": "def-server.createJsAgentInstructions", "type": "Function", + "tags": [], + "label": "createJsAgentInstructions", + "description": [], + "signature": [ + "(apmServerUrl?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; textPre: string; commands: string[]; textPost?: undefined; })[]" + ], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 393 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apmOss", "id": "def-server.createJsAgentInstructions.$1", "type": "string", + "tags": [], "label": "apmServerUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 393 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(apmServerUrl?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; textPre: string; commands: string[]; textPost?: undefined; })[]" - ], - "description": [], - "label": "createJsAgentInstructions", - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 393 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "apmOss", "id": "def-server.createNodeAgentInstructions", "type": "Function", + "tags": [], + "label": "createNodeAgentInstructions", + "description": [], + "signature": [ + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + ], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apmOss", "id": "def-server.createNodeAgentInstructions.$1", "type": "string", + "tags": [], "label": "apmServerUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apmOss", "id": "def-server.createNodeAgentInstructions.$2", "type": "string", + "tags": [], "label": "secretToken", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "description": [], - "label": "createNodeAgentInstructions", - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 11 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "apmOss", "id": "def-server.createPhpAgentInstructions", "type": "Function", + "tags": [], + "label": "createPhpAgentInstructions", + "description": [], + "signature": [ + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + ], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 705 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apmOss", "id": "def-server.createPhpAgentInstructions.$1", "type": "string", + "tags": [], "label": "apmServerUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 705 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apmOss", "id": "def-server.createPhpAgentInstructions.$2", "type": "string", + "tags": [], "label": "secretToken", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 705 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "description": [], - "label": "createPhpAgentInstructions", - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 705 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "apmOss", "id": "def-server.createRackAgentInstructions", "type": "Function", + "tags": [], + "label": "createRackAgentInstructions", + "description": [], + "signature": [ + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + ], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 298 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apmOss", "id": "def-server.createRackAgentInstructions.$1", "type": "string", + "tags": [], "label": "apmServerUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 298 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apmOss", "id": "def-server.createRackAgentInstructions.$2", "type": "string", + "tags": [], "label": "secretToken", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 298 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "description": [], - "label": "createRackAgentInstructions", - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 298 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "apmOss", "id": "def-server.createRailsAgentInstructions", "type": "Function", + "tags": [], + "label": "createRailsAgentInstructions", + "description": [], + "signature": [ + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + ], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 255 + }, + "deprecated": false, "children": [ { + "parentPluginId": "apmOss", "id": "def-server.createRailsAgentInstructions.$1", "type": "string", + "tags": [], "label": "apmServerUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 255 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "apmOss", "id": "def-server.createRailsAgentInstructions.$2", "type": "string", + "tags": [], "label": "secretToken", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 255 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "description": [], - "label": "createRailsAgentInstructions", - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 255 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } @@ -506,77 +589,94 @@ "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "apmOss", "id": "def-server.APM_STATIC_INDEX_PATTERN_ID", "type": "string", + "tags": [], "label": "APM_STATIC_INDEX_PATTERN_ID", "description": [], + "signature": [ + "\"apm_static_index_pattern_id\"" + ], "source": { "path": "src/plugins/apm_oss/common/index_pattern_constants.ts", "lineNumber": 9 }, - "signature": [ - "\"apm_static_index_pattern_id\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "apmOss", "id": "def-server.APMOSSConfig", "type": "Type", - "label": "APMOSSConfig", "tags": [], + "label": "APMOSSConfig", "description": [], + "signature": [ + "{ readonly enabled: boolean; readonly transactionIndices: string; readonly spanIndices: string; readonly errorIndices: string; readonly metricsIndices: string; readonly sourcemapIndices: string; readonly onboardingIndices: string; readonly indexPattern: string; readonly fleetMode: boolean; }" + ], "source": { "path": "src/plugins/apm_oss/server/index.ts", "lineNumber": 32 }, - "signature": [ - "{ readonly enabled: boolean; readonly transactionIndices: string; readonly spanIndices: string; readonly errorIndices: string; readonly metricsIndices: string; readonly sourcemapIndices: string; readonly onboardingIndices: string; readonly indexPattern: string; readonly fleetMode: boolean; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "apmOss", "id": "def-server.APMOSSPluginSetup", "type": "Interface", + "tags": [], "label": "APMOSSPluginSetup", "description": [], - "tags": [], + "source": { + "path": "src/plugins/apm_oss/server/plugin.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "apmOss", "id": "def-server.APMOSSPluginSetup.config", "type": "Object", + "tags": [], "label": "config", "description": [], + "signature": [ + "Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>" + ], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", "lineNumber": 48 }, - "signature": [ - "Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "apmOss", "id": "def-server.APMOSSPluginSetup.config$", "type": "Object", + "tags": [], "label": "config$", "description": [], + "signature": [ + "Observable", + ">" + ], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", "lineNumber": 49 }, - "signature": [ - "Observable", - ">" - ] + "deprecated": false }, { + "parentPluginId": "apmOss", "id": "def-server.APMOSSPluginSetup.getRegisteredTutorialProvider", "type": "Function", + "tags": [], "label": "getRegisteredTutorialProvider", + "description": [], "signature": [ "() => ", { @@ -587,20 +687,15 @@ "text": "TutorialProvider" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", "lineNumber": 50 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/apm_oss/server/plugin.ts", - "lineNumber": 47 - }, "lifecycle": "setup", "initialIsOpen": true } diff --git a/api_docs/banners.json b/api_docs/banners.json index 15fe714af2007..27810c9ecc5db 100644 --- a/api_docs/banners.json +++ b/api_docs/banners.json @@ -21,22 +21,25 @@ "functions": [], "interfaces": [ { + "parentPluginId": "banners", "id": "def-common.BannerConfiguration", "type": "Interface", + "tags": [], "label": "BannerConfiguration", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "banners", "id": "def-common.BannerConfiguration.placement", "type": "CompoundType", + "tags": [], "label": "placement", "description": [], - "source": { - "path": "x-pack/plugins/banners/common/types.ts", - "lineNumber": 16 - }, "signature": [ { "pluginId": "banners", @@ -45,76 +48,88 @@ "section": "def-common.BannerPlacement", "text": "BannerPlacement" } - ] + ], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 16 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "banners", "id": "def-common.BannerConfiguration.textContent", "type": "string", + "tags": [], "label": "textContent", "description": [], "source": { "path": "x-pack/plugins/banners/common/types.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "banners", "id": "def-common.BannerConfiguration.textColor", "type": "string", + "tags": [], "label": "textColor", "description": [], "source": { "path": "x-pack/plugins/banners/common/types.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "banners", "id": "def-common.BannerConfiguration.backgroundColor", "type": "string", + "tags": [], "label": "backgroundColor", "description": [], "source": { "path": "x-pack/plugins/banners/common/types.ts", "lineNumber": 19 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/banners/common/types.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "banners", "id": "def-common.BannerInfoResponse", "type": "Interface", + "tags": [], "label": "BannerInfoResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "banners", "id": "def-common.BannerInfoResponse.allowed", "type": "boolean", + "tags": [], "label": "allowed", "description": [], "source": { "path": "x-pack/plugins/banners/common/types.ts", "lineNumber": 9 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "banners", "id": "def-common.BannerInfoResponse.banner", "type": "Object", + "tags": [], "label": "banner", "description": [], - "source": { - "path": "x-pack/plugins/banners/common/types.ts", - "lineNumber": 10 - }, "signature": [ { "pluginId": "banners", @@ -123,31 +138,34 @@ "section": "def-common.BannerConfiguration", "text": "BannerConfiguration" } - ] + ], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 10 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/banners/common/types.ts", - "lineNumber": 8 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "banners", "id": "def-common.BannerPlacement", "type": "Type", - "label": "BannerPlacement", "tags": [], + "label": "BannerPlacement", "description": [], + "signature": [ + "\"top\" | \"disabled\"" + ], "source": { "path": "x-pack/plugins/banners/common/types.ts", "lineNumber": 13 }, - "signature": [ - "\"top\" | \"disabled\"" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/beats_management.json b/api_docs/beats_management.json index 5ab0902828ee1..7c892e468d4a0 100644 --- a/api_docs/beats_management.json +++ b/api_docs/beats_management.json @@ -23,32 +23,31 @@ "enums": [], "misc": [ { + "parentPluginId": "beatsManagement", "id": "def-common.BeatsManagementConfigType", "type": "Type", - "label": "BeatsManagementConfigType", "tags": [], + "label": "BeatsManagementConfigType", "description": [], + "signature": [ + "{ readonly enabled: boolean; readonly defaultUserRoles: string[]; readonly encryptionKey: string; readonly enrollmentTokensTtlInSeconds: number; }" + ], "source": { "path": "x-pack/plugins/beats_management/common/index.ts", "lineNumber": 23 }, - "signature": [ - "{ readonly enabled: boolean; readonly defaultUserRoles: string[]; readonly encryptionKey: string; readonly enrollmentTokensTtlInSeconds: number; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [], + "parentPluginId": "beatsManagement", "id": "def-common.beatsManagementConfigSchema", "type": "Object", + "tags": [], "label": "beatsManagementConfigSchema", "description": [], - "source": { - "path": "x-pack/plugins/beats_management/common/index.ts", - "lineNumber": 12 - }, "signature": [ "ObjectType", "<{ enabled: ", @@ -60,6 +59,11 @@ "; enrollmentTokensTtlInSeconds: ", "Type" ], + "source": { + "path": "x-pack/plugins/beats_management/common/index.ts", + "lineNumber": 12 + }, + "deprecated": false, "initialIsOpen": false } ] diff --git a/api_docs/bfetch.json b/api_docs/bfetch.json index b3b251d2c49bb..35f1ce96b8d3f 100644 --- a/api_docs/bfetch.json +++ b/api_docs/bfetch.json @@ -4,40 +4,45 @@ "classes": [], "functions": [ { + "parentPluginId": "bfetch", "id": "def-public.split", "type": "Function", + "tags": [], + "label": "split", + "description": [ + "\nReceives observable that emits strings, and returns a new observable\nthat also returns strings separated by delimiter.\n\nInput stream:\n\n asdf.f -> df..aaa. -> dfsdf\n\nOutput stream, assuming \".\" is used as delimiter:\n\n asdf -> fdf -> aaa -> dfsdf\n" + ], + "signature": [ + "(delimiter?: string) => (in$: ", + "Observable", + ") => ", + "Observable", + "" + ], + "source": { + "path": "src/plugins/bfetch/public/streaming/split.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "bfetch", "id": "def-public.split.$1", "type": "string", + "tags": [], "label": "delimiter", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/bfetch/public/streaming/split.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(delimiter?: string) => (in$: ", - "Observable", - ") => ", - "Observable", - "" - ], - "description": [ - "\nReceives observable that emits strings, and returns a new observable\nthat also returns strings separated by delimiter.\n\nInput stream:\n\n asdf.f -> df..aaa. -> dfsdf\n\nOutput stream, assuming \".\" is used as delimiter:\n\n asdf -> fdf -> aaa -> dfsdf\n" - ], - "label": "split", - "source": { - "path": "src/plugins/bfetch/public/streaming/split.ts", - "lineNumber": 25 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } @@ -46,57 +51,64 @@ "enums": [], "misc": [ { + "parentPluginId": "bfetch", "id": "def-public.BatchedFunc", "type": "Type", - "label": "BatchedFunc", "tags": [], + "label": "BatchedFunc", "description": [], + "signature": [ + "(payload: Payload, signal: AbortSignal | undefined) => Promise" + ], "source": { "path": "src/plugins/bfetch/public/batching/types.ts", "lineNumber": 17 }, - "signature": [ - "(payload: Payload, signal: AbortSignal | undefined) => Promise" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "start": { + "parentPluginId": "bfetch", "id": "def-public.BfetchPublicContract", "type": "Interface", + "tags": [], "label": "BfetchPublicContract", "description": [], - "tags": [], + "source": { + "path": "src/plugins/bfetch/public/plugin.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "bfetch", "id": "def-public.BfetchPublicContract.fetchStreaming", "type": "Function", + "tags": [], "label": "fetchStreaming", "description": [], - "source": { - "path": "src/plugins/bfetch/public/plugin.ts", - "lineNumber": 25 - }, "signature": [ "(params: ", "FetchStreamingParams", ") => { xhr: XMLHttpRequest; stream: ", "Observable", "; }" - ] + ], + "source": { + "path": "src/plugins/bfetch/public/plugin.ts", + "lineNumber": 25 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "bfetch", "id": "def-public.BfetchPublicContract.batchedFunction", "type": "Function", + "tags": [], "label": "batchedFunction", "description": [], - "source": { - "path": "src/plugins/bfetch/public/plugin.ts", - "lineNumber": 26 - }, "signature": [ "(params: ", "StreamingBatchedFunctionParams", @@ -109,13 +121,14 @@ "text": "BatchedFunc" }, "" - ] + ], + "source": { + "path": "src/plugins/bfetch/public/plugin.ts", + "lineNumber": 26 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/bfetch/public/plugin.ts", - "lineNumber": 24 - }, "lifecycle": "start", "initialIsOpen": true } @@ -125,9 +138,12 @@ "functions": [], "interfaces": [ { + "parentPluginId": "bfetch", "id": "def-server.BatchProcessingRouteParams", "type": "Interface", + "tags": [], "label": "BatchProcessingRouteParams", + "description": [], "signature": [ { "pluginId": "bfetch", @@ -138,47 +154,43 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "bfetch", "id": "def-server.BatchProcessingRouteParams.onBatchItem", "type": "Function", + "tags": [], "label": "onBatchItem", "description": [], + "signature": [ + "(data: BatchItemData) => Promise" + ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 40 }, - "signature": [ - "(data: BatchItemData) => Promise" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 39 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "bfetch", "id": "def-server.StreamingRequestHandler", "type": "Type", + "tags": [], "label": "StreamingRequestHandler", - "tags": [ - "public" - ], "description": [ "\nRequest handler modified to allow to return an observable.\n\nSee {@link BfetchServerSetup.createStreamingRequestHandler} for usage example." ], - "source": { - "path": "src/plugins/bfetch/server/types.ts", - "lineNumber": 18 - }, "signature": [ "(context: ", { @@ -202,29 +214,35 @@ "Observable", ">" ], + "source": { + "path": "src/plugins/bfetch/server/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "bfetch", "id": "def-server.BfetchServerSetup", "type": "Interface", + "tags": [], "label": "BfetchServerSetup", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "bfetch", "id": "def-server.BfetchServerSetup.addBatchProcessingRoute", "type": "Function", + "tags": [], "label": "addBatchProcessingRoute", "description": [], - "source": { - "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 45 - }, "signature": [ "(path: string, handler: (request: ", { @@ -243,18 +261,20 @@ "text": "BatchProcessingRouteParams" }, ") => void" - ] + ], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 45 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "bfetch", "id": "def-server.BfetchServerSetup.addStreamingResponseRoute", "type": "Function", + "tags": [], "label": "addStreamingResponseRoute", "description": [], - "source": { - "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 49 - }, "signature": [ "(path: string, params: (request: ", { @@ -273,20 +293,22 @@ "text": "StreamingResponseHandler" }, ") => void" - ] + ], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 49 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "bfetch", "id": "def-server.BfetchServerSetup.createStreamingRequestHandler", "type": "Function", + "tags": [], "label": "createStreamingRequestHandler", "description": [ "\nCreate a streaming request handler to be able to use an Observable to return chunked content to the client.\nThis is meant to be used with the `fetchStreaming` API of the `bfetch` client-side plugin.\n" ], - "source": { - "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 81 - }, "signature": [ "" ], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "bfetch", "id": "def-common.ItemBuffer.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "bfetch", "id": "def-common.ItemBuffer.Unnamed.$1", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "bfetch", @@ -398,110 +438,114 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", - "lineNumber": 32 - } + "returnComment": [] }, { + "parentPluginId": "bfetch", "id": "def-common.ItemBuffer.length", "type": "number", - "label": "length", "tags": [], + "label": "length", "description": [ "\nGet current buffer size." ], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 37 - } + }, + "deprecated": false }, { + "parentPluginId": "bfetch", "id": "def-common.ItemBuffer.write", "type": "Function", + "tags": [], "label": "write", - "signature": [ - "(item: Item) => void" - ], "description": [ "\nAdd item to the buffer." ], + "signature": [ + "(item: Item) => void" + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { + "parentPluginId": "bfetch", "id": "def-common.ItemBuffer.write.$1", "type": "Uncategorized", + "tags": [], "label": "item", - "isRequired": true, + "description": [], "signature": [ "Item" ], - "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 44 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", - "lineNumber": 44 - } + "returnComment": [] }, { + "parentPluginId": "bfetch", "id": "def-common.ItemBuffer.clear", "type": "Function", + "tags": [], "label": "clear", - "signature": [ - "() => void" - ], "description": [ "\nRemove all items from the buffer." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 58 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "bfetch", "id": "def-common.ItemBuffer.flush", "type": "Function", + "tags": [], "label": "flush", - "signature": [ - "() => void" - ], "description": [ "\nCall `.onflush` method and clear buffer." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 65 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "bfetch", "id": "def-common.TimedItemBuffer", "type": "Class", "tags": [], @@ -525,21 +569,35 @@ }, "" ], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "bfetch", "id": "def-common.TimedItemBuffer.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "bfetch", "id": "def-common.TimedItemBuffer.Unnamed.$1", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "bfetch", @@ -550,118 +608,100 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", - "lineNumber": 22 - } + "returnComment": [] }, { + "parentPluginId": "bfetch", "id": "def-common.TimedItemBuffer.write", "type": "Function", + "tags": [], "label": "write", + "description": [], "signature": [ "(item: Item) => void" ], - "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "bfetch", "id": "def-common.TimedItemBuffer.write.$1", "type": "Uncategorized", + "tags": [], "label": "item", - "isRequired": true, + "description": [], "signature": [ "Item" ], - "description": [], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", - "lineNumber": 26 - } + "returnComment": [] }, { + "parentPluginId": "bfetch", "id": "def-common.TimedItemBuffer.clear", "type": "Function", + "tags": [], "label": "clear", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "bfetch", "id": "def-common.TimedItemBuffer.flush", "type": "Function", + "tags": [], "label": "flush", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", - "lineNumber": 19 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "bfetch", "id": "def-common.createBatchedFunction", "type": "Function", - "children": [ - { - "id": "def-common.createBatchedFunction.$1", - "type": "Object", - "label": "params", - "isRequired": true, - "signature": [ - { - "pluginId": "bfetch", - "scope": "common", - "docId": "kibBfetchPluginApi", - "section": "def-common.BatchedFunctionParams", - "text": "BatchedFunctionParams" - }, - "" - ], - "description": [], - "source": { - "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", - "lineNumber": 22 - } - } - ], + "tags": [], + "label": "createBatchedFunction", + "description": [], "signature": [ "(params: ", { @@ -681,35 +721,47 @@ }, "]" ], - "description": [], - "label": "createBatchedFunction", "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 21 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.normalizeError", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.normalizeError.$1", - "type": "Any", - "label": "err", - "isRequired": true, + "parentPluginId": "bfetch", + "id": "def-common.createBatchedFunction.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], "signature": [ - "any" + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.BatchedFunctionParams", + "text": "BatchedFunctionParams" + }, + "" ], - "description": [], "source": { - "path": "src/plugins/bfetch/common/util/normalize_error.ts", - "lineNumber": 11 - } + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 22 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "bfetch", + "id": "def-common.normalizeError", + "type": "Function", + "tags": [], + "label": "normalizeError", + "description": [], "signature": [ "(err: any) => E" ], - "description": [], - "label": "normalizeError", "source": { "path": "src/plugins/bfetch/common/util/normalize_error.ts", "lineNumber": 11 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-common.normalizeError.$1", + "type": "Any", + "tags": [], + "label": "err", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/bfetch/common/util/normalize_error.ts", + "lineNumber": 11 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "bfetch", "id": "def-common.removeLeadingSlash", "type": "Function", + "tags": [], + "label": "removeLeadingSlash", + "description": [], + "signature": [ + "(text: string) => string" + ], + "source": { + "path": "src/plugins/bfetch/common/util/remove_leading_slash.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "bfetch", "id": "def-common.removeLeadingSlash.$1", "type": "string", + "tags": [], "label": "text", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/bfetch/common/util/remove_leading_slash.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(text: string) => string" - ], - "description": [], - "label": "removeLeadingSlash", - "source": { - "path": "src/plugins/bfetch/common/util/remove_leading_slash.ts", - "lineNumber": 9 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "bfetch", "id": "def-common.BatchedFunctionParams", "type": "Interface", + "tags": [], "label": "BatchedFunctionParams", + "description": [], "signature": [ { "pluginId": "bfetch", @@ -787,76 +864,86 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.BatchedFunctionParams.onCall", "type": "Function", + "tags": [], "label": "onCall", "description": [], + "signature": [ + "(...args: Parameters) => [ReturnType, BatchEntry]" + ], "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 15 }, - "signature": [ - "(...args: Parameters) => [ReturnType, BatchEntry]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.BatchedFunctionParams.onBatch", "type": "Function", + "tags": [], "label": "onBatch", "description": [], + "signature": [ + "(items: BatchEntry[]) => void" + ], "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 16 }, - "signature": [ - "(items: BatchEntry[]) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.BatchedFunctionParams.flushOnMaxItems", "type": "number", + "tags": [], "label": "flushOnMaxItems", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 17 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.BatchedFunctionParams.maxItemAge", "type": "number", + "tags": [], "label": "maxItemAge", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 18 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "bfetch", "id": "def-common.BatchRequestData", "type": "Interface", + "tags": [], "label": "BatchRequestData", + "description": [], "signature": [ { "pluginId": "bfetch", @@ -867,34 +954,38 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.BatchRequestData.batch", "type": "Array", + "tags": [], "label": "batch", "description": [], + "signature": [ + "Item[]" + ], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 14 }, - "signature": [ - "Item[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/bfetch/common/batch.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "bfetch", "id": "def-common.BatchResponseItem", "type": "Interface", + "tags": [], "label": "BatchResponseItem", + "description": [], "signature": [ { "pluginId": "bfetch", @@ -905,84 +996,96 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.BatchResponseItem.id", "type": "number", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.BatchResponseItem.result", "type": "Uncategorized", + "tags": [], "label": "result", "description": [], + "signature": [ + "Result | undefined" + ], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 19 }, - "signature": [ - "Result | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.BatchResponseItem.error", "type": "Uncategorized", + "tags": [], "label": "error", "description": [], + "signature": [ + "Error | undefined" + ], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 20 }, - "signature": [ - "Error | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/bfetch/common/batch.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "bfetch", "id": "def-common.ErrorLike", "type": "Interface", + "tags": [], "label": "ErrorLike", "description": [], - "tags": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.ErrorLike.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/plugins/bfetch/common/batch.ts", "lineNumber": 10 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/bfetch/common/batch.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "bfetch", "id": "def-common.ItemBufferParams", "type": "Interface", + "tags": [], "label": "ItemBufferParams", + "description": [], "signature": [ { "pluginId": "bfetch", @@ -993,52 +1096,58 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.ItemBufferParams.flushOnMaxItems", "type": "number", + "tags": [], "label": "flushOnMaxItems", "description": [ "\nFlushes buffer automatically if number of items in the buffer reaches\nthis number. Omit it or set to `Infinity` to never flush on max buffer\nsize automatically." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 15 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.ItemBufferParams.onFlush", "type": "Function", + "tags": [], "label": "onFlush", "description": [ "\nCallback that is called every time buffer is flushed. It receives a single\nargument which is a list of all buffered items. If `.flush()` is called\nwhen buffer is empty, `.onflush` is called with empty array." ], + "signature": [ + "(items: Item[]) => void" + ], "source": { "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 22 }, - "signature": [ - "(items: Item[]) => void" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "bfetch", "id": "def-common.StreamingResponseHandler", "type": "Interface", + "tags": [], "label": "StreamingResponseHandler", + "description": [], "signature": [ { "pluginId": "bfetch", @@ -1049,53 +1158,60 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/bfetch/common/streaming/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "bfetch", "id": "def-common.StreamingResponseHandler.getResponseStream", "type": "Function", + "tags": [], "label": "getResponseStream", + "description": [], "signature": [ "(payload: Payload) => ", "Observable", "" ], - "description": [], + "source": { + "path": "src/plugins/bfetch/common/streaming/types.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "bfetch", "id": "def-common.StreamingResponseHandler.getResponseStream.$1", "type": "Uncategorized", + "tags": [], "label": "payload", - "isRequired": true, + "description": [], "signature": [ "Payload" ], - "description": [], "source": { "path": "src/plugins/bfetch/common/streaming/types.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/bfetch/common/streaming/types.ts", - "lineNumber": 12 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/bfetch/common/streaming/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "bfetch", "id": "def-common.TimedItemBufferParams", "type": "Interface", + "tags": [], "label": "TimedItemBufferParams", + "description": [], "signature": [ { "pluginId": "bfetch", @@ -1114,30 +1230,31 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "bfetch", "id": "def-common.TimedItemBufferParams.maxItemAge", "type": "number", + "tags": [], "label": "maxItemAge", "description": [ "\nFlushes buffer when oldest item reaches age specified by this parameter,\nin milliseconds." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", "lineNumber": 16 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", - "lineNumber": 11 - }, "initialIsOpen": false } ], diff --git a/api_docs/canvas.json b/api_docs/canvas.json index e4b56ae0d6aa1..8e7707b993643 100644 --- a/api_docs/canvas.json +++ b/api_docs/canvas.json @@ -5,22 +5,25 @@ "functions": [], "interfaces": [ { + "parentPluginId": "canvas", "id": "def-public.WithKibanaProps", "type": "Interface", + "tags": [], "label": "WithKibanaProps", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/canvas/public/index.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "canvas", "id": "def-public.WithKibanaProps.kibana", "type": "Object", + "tags": [], "label": "kibana", "description": [], - "source": { - "path": "x-pack/plugins/canvas/public/index.ts", - "lineNumber": 16 - }, "signature": [ "{ services: ", { @@ -35,13 +38,14 @@ " & { canvas: ", "CanvasServices", "; }; }" - ] + ], + "source": { + "path": "x-pack/plugins/canvas/public/index.ts", + "lineNumber": 16 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/canvas/public/index.ts", - "lineNumber": 15 - }, "initialIsOpen": false } ], @@ -49,38 +53,40 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "canvas", "id": "def-public.CanvasSetup", "type": "Type", + "tags": [], "label": "CanvasSetup", - "tags": [ - "public" - ], "description": [ "\nThese are the interfaces with your public contracts. You should export these\nfor other plugins to use in _their_ `SetupDeps`/`StartDeps` interfaces." ], - "source": { - "path": "x-pack/plugins/canvas/public/plugin.tsx", - "lineNumber": 65 - }, "signature": [ "CanvasApi" ], + "source": { + "path": "x-pack/plugins/canvas/public/plugin.tsx", + "lineNumber": 68 + }, + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "canvas", "id": "def-public.CanvasStart", "type": "Type", - "label": "CanvasStart", "tags": [], + "label": "CanvasStart", "description": [], - "source": { - "path": "x-pack/plugins/canvas/public/plugin.tsx", - "lineNumber": 66 - }, "signature": [ "void" ], + "source": { + "path": "x-pack/plugins/canvas/public/plugin.tsx", + "lineNumber": 69 + }, + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -99,6 +105,36 @@ "interfaces": [], "enums": [], "misc": [], - "objects": [] + "objects": [ + { + "parentPluginId": "canvas", + "id": "def-common.UI_SETTINGS", + "type": "Object", + "tags": [], + "label": "UI_SETTINGS", + "description": [], + "source": { + "path": "x-pack/plugins/canvas/common/index.ts", + "lineNumber": 8 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "canvas", + "id": "def-common.UI_SETTINGS.ENABLE_LABS_UI", + "type": "string", + "tags": [], + "label": "ENABLE_LABS_UI", + "description": [], + "source": { + "path": "x-pack/plugins/canvas/common/index.ts", + "lineNumber": 9 + }, + "deprecated": false + } + ], + "initialIsOpen": false + } + ] } } \ No newline at end of file diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index 4555d2bf9fef3..75ac78d571bc9 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -22,3 +22,8 @@ import canvasObj from './canvas.json'; ### Interfaces +## Common + +### Objects + + diff --git a/api_docs/cases.json b/api_docs/cases.json index 71538a0ad5d47..190fbfe95fc6d 100644 --- a/api_docs/cases.json +++ b/api_docs/cases.json @@ -1,44 +1,596 @@ { "id": "cases", "client": { - "classes": [], + "classes": [ + { + "parentPluginId": "cases", + "id": "def-public.CasesUiPlugin", + "type": "Class", + "tags": [], + "label": "CasesUiPlugin", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.CasesUiPlugin", + "text": "CasesUiPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "" + ], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 29 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "cases", + "id": "def-public.CasesUiPlugin.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + ", plugins: ", + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.SetupPlugins", + "text": "SetupPlugins" + }, + ") => void" + ], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.CasesUiPlugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-public.CasesUiPlugin.setup.$2", + "type": "Object", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.SetupPlugins", + "text": "SetupPlugins" + } + ], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "cases", + "id": "def-public.CasesUiPlugin.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", plugins: ", + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.StartPlugins", + "text": "StartPlugins" + }, + ") => ", + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.CasesUiStart", + "text": "CasesUiStart" + } + ], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 38 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.CasesUiPlugin.start.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 38 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-public.CasesUiPlugin.start.$2", + "type": "Object", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.StartPlugins", + "text": "StartPlugins" + } + ], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 38 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "cases", + "id": "def-public.CasesUiPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "() => void" + ], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 92 + }, + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], "functions": [], - "interfaces": [], + "interfaces": [ + { + "parentPluginId": "cases", + "id": "def-public.SetupPlugins", + "type": "Interface", + "tags": [], + "label": "SetupPlugins", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 22 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.SetupPlugins.security", + "type": "Object", + "tags": [], + "label": "security", + "description": [], + "signature": [ + "{ authc: ", + "AuthenticationServiceSetup", + "; sessionTimeout: ", + "ISessionTimeout", + "; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ", + "SecurityLicenseFeatures", + "; features$: ", + "Observable", + "<", + "SecurityLicenseFeatures" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 23 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-public.SetupPlugins.triggersActionsUi", + "type": "Object", + "tags": [], + "label": "triggersActionsUi", + "description": [], + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.TriggersAndActionsUIPublicPluginSetup", + "text": "TriggersAndActionsUIPublicPluginSetup" + } + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 24 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-public.StartPlugins", + "type": "Interface", + "tags": [], + "label": "StartPlugins", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 27 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.StartPlugins.triggersActionsUi", + "type": "Object", + "tags": [], + "label": "triggersActionsUi", + "description": [], + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.TriggersAndActionsUIPublicPluginStart", + "text": "TriggersAndActionsUIPublicPluginStart" + } + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 28 + }, + "deprecated": false + } + ], + "initialIsOpen": false + } + ], "enums": [], - "misc": [], - "objects": [] + "misc": [ + { + "parentPluginId": "cases", + "id": "def-public.StartServices", + "type": "Type", + "tags": [], + "label": "StartServices", + "description": [ + "\nTODO: The extra security service is one that should be implemented in the kibana context of the consuming application.\nSecurity is needed for access to authc for the `useCurrentUser` hook. Security_Solution currently passes it via renderApp in public/plugin.tsx\nLeaving it out currently in lieu of RBAC changes" + ], + "signature": [ + "CoreStart & StartPlugins & { security: SecurityPluginSetup; }" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 37 + }, + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [], + "start": { + "parentPluginId": "cases", + "id": "def-public.CasesUiStart", + "type": "Interface", + "tags": [], + "label": "CasesUiStart", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 42 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.CasesUiStart.getAllCases", + "type": "Function", + "tags": [], + "label": "getAllCases", + "description": [], + "signature": [ + "(props: ", + "AllCasesProps", + ") => React.ReactElement<", + "AllCasesProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-public.CasesUiStart.getAllCasesSelectorModal", + "type": "Function", + "tags": [], + "label": "getAllCasesSelectorModal", + "description": [], + "signature": [ + "(props: ", + "AllCasesSelectorModalProps", + ") => React.ReactElement<", + "AllCasesSelectorModalProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-public.CasesUiStart.getCaseView", + "type": "Function", + "tags": [], + "label": "getCaseView", + "description": [], + "signature": [ + "(props: ", + "CaseViewProps", + ") => React.ReactElement<", + "CaseViewProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 47 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-public.CasesUiStart.getConfigureCases", + "type": "Function", + "tags": [], + "label": "getConfigureCases", + "description": [], + "signature": [ + "(props: ", + "ConfigureCasesProps", + ") => React.ReactElement<", + "ConfigureCasesProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 48 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-public.CasesUiStart.getCreateCase", + "type": "Function", + "tags": [], + "label": "getCreateCase", + "description": [], + "signature": [ + "(props: ", + "CreateCaseProps", + ") => React.ReactElement<", + "CreateCaseProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 49 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-public.CasesUiStart.getRecentCases", + "type": "Function", + "tags": [], + "label": "getRecentCases", + "description": [], + "signature": [ + "(props: ", + "RecentCasesProps", + ") => React.ReactElement<", + "RecentCasesProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 50 + }, + "deprecated": false + } + ], + "lifecycle": "start", + "initialIsOpen": true + } }, "server": { "classes": [], "functions": [], "interfaces": [ { + "parentPluginId": "cases", "id": "def-server.CaseRequestContext", "type": "Interface", + "tags": [], "label": "CaseRequestContext", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/server/types.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cases", "id": "def-server.CaseRequestContext.getCasesClient", "type": "Function", + "tags": [], "label": "getCasesClient", "description": [], - "source": { - "path": "x-pack/plugins/cases/server/types.ts", - "lineNumber": 14 - }, "signature": [ "() => ", "CasesClient" - ] + ], + "source": { + "path": "x-pack/plugins/cases/server/types.ts", + "lineNumber": 13 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/server/types.ts", - "lineNumber": 13 - }, "initialIsOpen": false } ], @@ -48,10 +600,7200 @@ }, "common": { "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] + "functions": [ + { + "parentPluginId": "cases", + "id": "def-common.createPlainError", + "type": "Function", + "tags": [], + "label": "createPlainError", + "description": [], + "signature": [ + "(message: string) => Error" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 49 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.createPlainError.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 49 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.decodeOrThrow", + "type": "Function", + "tags": [], + "label": "decodeOrThrow", + "description": [], + "signature": [ + "(runtimeType: ", + "Type", + ", createError?: ErrorFactory) => (inputValue: I) => A" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 55 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.decodeOrThrow.$1", + "type": "Object", + "tags": [], + "label": "runtimeType", + "description": [], + "signature": [ + "Type", + "" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 56 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-common.decodeOrThrow.$2", + "type": "Function", + "tags": [], + "label": "createError", + "description": [], + "signature": [ + "ErrorFactory" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 57 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.excess", + "type": "Function", + "tags": [], + "label": "excess", + "description": [], + "signature": [ + "(codec: C) => C" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 71 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.excess.$1", + "type": "Uncategorized", + "tags": [], + "label": "codec", + "description": [], + "signature": [ + "C" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 71 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.formatErrors", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "formatErrors", + "description": [], + "signature": [ + "(errors: ", + "Errors", + ") => string[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 20 + }, + "deprecated": true, + "references": [], + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.formatErrors.$1", + "type": "Object", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + "Errors" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 20 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCaseCommentDetailsUrl", + "type": "Function", + "tags": [], + "label": "getCaseCommentDetailsUrl", + "description": [], + "signature": [ + "(caseId: string, commentId: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 35 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.getCaseCommentDetailsUrl.$1", + "type": "string", + "tags": [], + "label": "caseId", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 35 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-common.getCaseCommentDetailsUrl.$2", + "type": "string", + "tags": [], + "label": "commentId", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 35 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCaseCommentsUrl", + "type": "Function", + "tags": [], + "label": "getCaseCommentsUrl", + "description": [], + "signature": [ + "(id: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 31 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.getCaseCommentsUrl.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 31 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCaseDetailsUrl", + "type": "Function", + "tags": [], + "label": "getCaseDetailsUrl", + "description": [], + "signature": [ + "(id: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 19 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.getCaseDetailsUrl.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 19 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCasePushUrl", + "type": "Function", + "tags": [], + "label": "getCasePushUrl", + "description": [], + "signature": [ + "(caseId: string, connectorId: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 47 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.getCasePushUrl.$1", + "type": "string", + "tags": [], + "label": "caseId", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 47 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-common.getCasePushUrl.$2", + "type": "string", + "tags": [], + "label": "connectorId", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 47 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCaseUserActionUrl", + "type": "Function", + "tags": [], + "label": "getCaseUserActionUrl", + "description": [], + "signature": [ + "(id: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 39 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.getCaseUserActionUrl.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 39 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getSubCaseDetailsUrl", + "type": "Function", + "tags": [], + "label": "getSubCaseDetailsUrl", + "description": [], + "signature": [ + "(caseID: string, subCaseId: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 27 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.getSubCaseDetailsUrl.$1", + "type": "string", + "tags": [], + "label": "caseID", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 27 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-common.getSubCaseDetailsUrl.$2", + "type": "string", + "tags": [], + "label": "subCaseId", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 27 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getSubCasesUrl", + "type": "Function", + "tags": [], + "label": "getSubCasesUrl", + "description": [], + "signature": [ + "(caseID: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 23 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.getSubCasesUrl.$1", + "type": "string", + "tags": [], + "label": "caseID", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 23 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getSubCaseUserActionUrl", + "type": "Function", + "tags": [], + "label": "getSubCaseUserActionUrl", + "description": [], + "signature": [ + "(caseID: string, subCaseId: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 43 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.getSubCaseUserActionUrl.$1", + "type": "string", + "tags": [], + "label": "caseID", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 43 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-common.getSubCaseUserActionUrl.$2", + "type": "string", + "tags": [], + "label": "subCaseId", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 43 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.throwErrors", + "type": "Function", + "tags": [], + "label": "throwErrors", + "description": [], + "signature": [ + "(createError: ErrorFactory) => (errors: ", + "Errors", + ") => never" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 51 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.throwErrors.$1", + "type": "Function", + "tags": [], + "label": "createError", + "description": [], + "signature": [ + "ErrorFactory" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 51 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "cases", + "id": "def-common.ActionLicense", + "type": "Interface", + "tags": [], + "label": "ActionLicense", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 144 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.ActionLicense.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 145 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ActionLicense.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 146 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ActionLicense.enabled", + "type": "boolean", + "tags": [], + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 147 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ActionLicense.enabledInConfig", + "type": "boolean", + "tags": [], + "label": "enabledInConfig", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 148 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ActionLicense.enabledInLicense", + "type": "boolean", + "tags": [], + "label": "enabledInLicense", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 149 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllCases", + "type": "Interface", + "tags": [], + "label": "AllCases", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AllCases", + "text": "AllCases" + }, + " extends ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CasesStatus", + "text": "CasesStatus" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 112 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.AllCases.cases", + "type": "Array", + "tags": [], + "label": "cases", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + }, + "[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 113 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllCases.page", + "type": "number", + "tags": [], + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 114 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllCases.perPage", + "type": "number", + "tags": [], + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 115 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllCases.total", + "type": "number", + "tags": [], + "label": "total", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 116 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ApiProps", + "type": "Interface", + "tags": [], + "label": "ApiProps", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 135 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.ApiProps.signal", + "type": "Object", + "tags": [], + "label": "signal", + "description": [], + "signature": [ + "AbortSignal" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 136 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.BulkUpdateStatus", + "type": "Interface", + "tags": [], + "label": "BulkUpdateStatus", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 139 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.BulkUpdateStatus.status", + "type": "string", + "tags": [], + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 140 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.BulkUpdateStatus.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 141 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.BulkUpdateStatus.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 142 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Case", + "type": "Interface", + "tags": [], + "label": "Case", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + }, + " extends BasicCase" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 80 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.Case.connector", + "type": "CompoundType", + "tags": [], + "label": "connector", + "description": [], + "signature": [ + "({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 81 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Case.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 82 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Case.externalService", + "type": "CompoundType", + "tags": [], + "label": "externalService", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseExternalService", + "text": "CaseExternalService" + }, + " | null" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 83 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Case.subCases", + "type": "CompoundType", + "tags": [], + "label": "subCases", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.SubCase", + "text": "SubCase" + }, + "[] | null | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 84 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Case.subCaseIds", + "type": "Array", + "tags": [], + "label": "subCaseIds", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 85 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Case.settings", + "type": "Object", + "tags": [], + "label": "settings", + "description": [], + "signature": [ + "{ syncAlerts: boolean; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 86 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Case.tags", + "type": "Array", + "tags": [], + "label": "tags", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 87 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Case.type", + "type": "Enum", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 88 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseExternalService", + "type": "Interface", + "tags": [], + "label": "CaseExternalService", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 49 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.CaseExternalService.pushedAt", + "type": "string", + "tags": [], + "label": "pushedAt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 50 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseExternalService.pushedBy", + "type": "Object", + "tags": [], + "label": "pushedBy", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ElasticUser", + "text": "ElasticUser" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 51 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseExternalService.connectorId", + "type": "string", + "tags": [], + "label": "connectorId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 52 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseExternalService.connectorName", + "type": "string", + "tags": [], + "label": "connectorName", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 53 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseExternalService.externalId", + "type": "string", + "tags": [], + "label": "externalId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 54 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseExternalService.externalTitle", + "type": "string", + "tags": [], + "label": "externalTitle", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 55 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseExternalService.externalUrl", + "type": "string", + "tags": [], + "label": "externalUrl", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 56 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesStatus", + "type": "Interface", + "tags": [], + "label": "CasesStatus", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 106 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.CasesStatus.countClosedCases", + "type": "CompoundType", + "tags": [], + "label": "countClosedCases", + "description": [], + "signature": [ + "number | null" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 107 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesStatus.countOpenCases", + "type": "CompoundType", + "tags": [], + "label": "countOpenCases", + "description": [], + "signature": [ + "number | null" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 108 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesStatus.countInProgressCases", + "type": "CompoundType", + "tags": [], + "label": "countInProgressCases", + "description": [], + "signature": [ + "number | null" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 109 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions", + "type": "Interface", + "tags": [], + "label": "CaseUserActions", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 37 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions.actionId", + "type": "string", + "tags": [], + "label": "actionId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 38 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions.actionField", + "type": "Array", + "tags": [], + "label": "actionField", + "description": [], + "signature": [ + "(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 39 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions.action", + "type": "CompoundType", + "tags": [], + "label": "action", + "description": [], + "signature": [ + "\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 40 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions.actionAt", + "type": "string", + "tags": [], + "label": "actionAt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 41 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions.actionBy", + "type": "Object", + "tags": [], + "label": "actionBy", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ElasticUser", + "text": "ElasticUser" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 42 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions.caseId", + "type": "string", + "tags": [], + "label": "caseId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions.commentId", + "type": "CompoundType", + "tags": [], + "label": "commentId", + "description": [], + "signature": [ + "string | null" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions.newValue", + "type": "CompoundType", + "tags": [], + "label": "newValue", + "description": [], + "signature": [ + "string | null" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 45 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions.oldValue", + "type": "CompoundType", + "tags": [], + "label": "oldValue", + "description": [], + "signature": [ + "string | null" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 46 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.DeleteCase", + "type": "Interface", + "tags": [], + "label": "DeleteCase", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 152 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.DeleteCase.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 153 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.DeleteCase.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + " | null" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 154 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.DeleteCase.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 155 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Ecs", + "type": "Interface", + "tags": [], + "label": "Ecs", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 225 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.Ecs._id", + "type": "string", + "tags": [], + "label": "_id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 226 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Ecs._index", + "type": "string", + "tags": [], + "label": "_index", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 227 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Ecs.signal", + "type": "Object", + "tags": [], + "label": "signal", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.SignalEcs", + "text": "SignalEcs" + }, + " | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 228 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ElasticUser", + "type": "Interface", + "tags": [], + "label": "ElasticUser", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 124 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.ElasticUser.email", + "type": "CompoundType", + "tags": [], + "label": "email", + "description": [], + "signature": [ + "string | null | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 125 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ElasticUser.fullName", + "type": "CompoundType", + "tags": [], + "label": "fullName", + "description": [], + "signature": [ + "string | null | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 126 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ElasticUser.username", + "type": "CompoundType", + "tags": [], + "label": "username", + "description": [], + "signature": [ + "string | null | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 127 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCaseConnector", + "type": "Interface", + "tags": [], + "label": "ESCaseConnector", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 100 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.ESCaseConnector.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 101 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCaseConnector.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 102 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCaseConnector.type", + "type": "Enum", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 103 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCaseConnector.fields", + "type": "CompoundType", + "tags": [], + "label": "fields", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ESConnectorFields", + "text": "ESConnectorFields" + }, + " | null" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 104 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FetchCasesProps", + "type": "Interface", + "tags": [], + "label": "FetchCasesProps", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.FetchCasesProps", + "text": "FetchCasesProps" + }, + " extends ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ApiProps", + "text": "ApiProps" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 130 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.FetchCasesProps.queryParams", + "type": "Object", + "tags": [], + "label": "queryParams", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.QueryParams", + "text": "QueryParams" + }, + " | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 131 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FetchCasesProps.filterOptions", + "type": "Object", + "tags": [], + "label": "filterOptions", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.FilterOptions", + "text": "FilterOptions" + }, + " | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 132 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FieldMappings", + "type": "Interface", + "tags": [], + "label": "FieldMappings", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 158 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.FieldMappings.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 159 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FieldMappings.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 160 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FilterOptions", + "type": "Interface", + "tags": [], + "label": "FilterOptions", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 98 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.FilterOptions.search", + "type": "string", + "tags": [], + "label": "search", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 99 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FilterOptions.status", + "type": "CompoundType", + "tags": [], + "label": "status", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatusWithAllStatus", + "text": "CaseStatusWithAllStatus" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 100 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FilterOptions.tags", + "type": "Array", + "tags": [], + "label": "tags", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 101 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FilterOptions.reporters", + "type": "Array", + "tags": [], + "label": "reporters", + "description": [], + "signature": [ + "{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 102 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FilterOptions.onlyCollectionType", + "type": "CompoundType", + "tags": [], + "label": "onlyCollectionType", + "description": [], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 103 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.QueryParams", + "type": "Interface", + "tags": [], + "label": "QueryParams", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 91 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.QueryParams.page", + "type": "number", + "tags": [], + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 92 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.QueryParams.perPage", + "type": "number", + "tags": [], + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 93 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.QueryParams.sortField", + "type": "Enum", + "tags": [], + "label": "sortField", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.SortFieldCase", + "text": "SortFieldCase" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 94 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.QueryParams.sortOrder", + "type": "CompoundType", + "tags": [], + "label": "sortOrder", + "description": [], + "signature": [ + "\"asc\" | \"desc\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 95 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs", + "type": "Interface", + "tags": [], + "label": "RuleEcs", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 178 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.id", + "type": "Array", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 179 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.rule_id", + "type": "Array", + "tags": [], + "label": "rule_id", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 180 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.name", + "type": "Array", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 181 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.false_positives", + "type": "Array", + "tags": [], + "label": "false_positives", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 182 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.saved_id", + "type": "Array", + "tags": [], + "label": "saved_id", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 183 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.timeline_id", + "type": "Array", + "tags": [], + "label": "timeline_id", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 184 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.timeline_title", + "type": "Array", + "tags": [], + "label": "timeline_title", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 185 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.max_signals", + "type": "Array", + "tags": [], + "label": "max_signals", + "description": [], + "signature": [ + "number[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 186 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.risk_score", + "type": "Array", + "tags": [], + "label": "risk_score", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 187 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.output_index", + "type": "Array", + "tags": [], + "label": "output_index", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 188 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.description", + "type": "Array", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 189 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.from", + "type": "Array", + "tags": [], + "label": "from", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 190 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.immutable", + "type": "Array", + "tags": [], + "label": "immutable", + "description": [], + "signature": [ + "boolean[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 191 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.index", + "type": "Array", + "tags": [], + "label": "index", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 192 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.interval", + "type": "Array", + "tags": [], + "label": "interval", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 193 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.language", + "type": "Array", + "tags": [], + "label": "language", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 194 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.query", + "type": "Array", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 195 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 196 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.severity", + "type": "Array", + "tags": [], + "label": "severity", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 197 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.tags", + "type": "Array", + "tags": [], + "label": "tags", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 198 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.threat", + "type": "Unknown", + "tags": [], + "label": "threat", + "description": [], + "signature": [ + "unknown" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 199 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.threshold", + "type": "Unknown", + "tags": [], + "label": "threshold", + "description": [], + "signature": [ + "unknown" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 200 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.type", + "type": "Array", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 201 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.size", + "type": "Array", + "tags": [], + "label": "size", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 202 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.to", + "type": "Array", + "tags": [], + "label": "to", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 203 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.enabled", + "type": "Array", + "tags": [], + "label": "enabled", + "description": [], + "signature": [ + "boolean[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 204 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.filters", + "type": "Unknown", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + "unknown" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 205 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.created_at", + "type": "Array", + "tags": [], + "label": "created_at", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 206 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.updated_at", + "type": "Array", + "tags": [], + "label": "updated_at", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 207 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.created_by", + "type": "Array", + "tags": [], + "label": "created_by", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 208 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.updated_by", + "type": "Array", + "tags": [], + "label": "updated_by", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 209 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.version", + "type": "Array", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 210 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.note", + "type": "Array", + "tags": [], + "label": "note", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 211 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RuleEcs.building_block_type", + "type": "Array", + "tags": [], + "label": "building_block_type", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 212 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SignalEcs", + "type": "Interface", + "tags": [], + "label": "SignalEcs", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 215 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.SignalEcs.rule", + "type": "Object", + "tags": [], + "label": "rule", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.RuleEcs", + "text": "RuleEcs" + }, + " | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 216 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SignalEcs.original_time", + "type": "Array", + "tags": [], + "label": "original_time", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 217 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SignalEcs.status", + "type": "Array", + "tags": [], + "label": "status", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 218 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SignalEcs.group", + "type": "Object", + "tags": [], + "label": "group", + "description": [], + "signature": [ + "{ id?: string[] | undefined; } | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 219 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SignalEcs.threshold_result", + "type": "Unknown", + "tags": [], + "label": "threshold_result", + "description": [], + "signature": [ + "unknown" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 222 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCase", + "type": "Interface", + "tags": [], + "label": "SubCase", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.SubCase", + "text": "SubCase" + }, + " extends BasicCase" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 75 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.SubCase.associationType", + "type": "Enum", + "tags": [], + "label": "associationType", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 76 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCase.caseParentId", + "type": "string", + "tags": [], + "label": "caseParentId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 77 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey", + "type": "Interface", + "tags": [], + "label": "UpdateByKey", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 168 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.updateKey", + "type": "CompoundType", + "tags": [], + "label": "updateKey", + "description": [], + "signature": [ + "\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 169 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.updateValue", + "type": "CompoundType", + "tags": [], + "label": "updateValue", + "description": [], + "signature": [ + "string | string[] | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 170 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.fetchCaseUserActions", + "type": "Function", + "tags": [], + "label": "fetchCaseUserActions", + "description": [], + "signature": [ + "((caseId: string, caseConnectorId: string, subCaseId?: string | undefined) => void) | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 171 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.updateCase", + "type": "Function", + "tags": [], + "label": "updateCase", + "description": [], + "signature": [ + "((newCase: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + }, + ") => void) | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 172 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.caseData", + "type": "Object", + "tags": [], + "label": "caseData", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 173 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.onSuccess", + "type": "Function", + "tags": [], + "label": "onSuccess", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 174 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.onError", + "type": "Function", + "tags": [], + "label": "onError", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 175 + }, + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "cases", + "id": "def-common.AssociationType", + "type": "Enum", + "tags": [], + "label": "AssociationType", + "description": [ + "\nthis is used to differentiate between an alert attached to a top-level case and a group of alerts that should only\nbe attached to a sub case. The reason we need this is because an alert group comment will have references to both a case and\nsub case when it is created. For us to be able to filter out alert groups in a top-level case we need a field to\nuse as a filter." + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 33 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseStatuses", + "type": "Enum", + "tags": [], + "label": "CaseStatuses", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 10 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseType", + "type": "Enum", + "tags": [], + "label": "CaseType", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 17 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentType", + "type": "Enum", + "tags": [], + "label": "CommentType", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 51 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorTypes", + "type": "Enum", + "tags": [], + "label": "ConnectorTypes", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 33 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SortFieldCase", + "type": "Enum", + "tags": [], + "label": "SortFieldCase", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 119 + }, + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "cases", + "id": "def-common.ACTION_TYPES_URL", + "type": "string", + "tags": [], + "label": "ACTION_TYPES_URL", + "description": [], + "signature": [ + "\"/api/actions/list_action_types\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 41 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ACTION_URL", + "type": "string", + "tags": [], + "label": "ACTION_URL", + "description": [ + "\nAction routes" + ], + "signature": [ + "\"/api/actions\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 40 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ActionConnector", + "type": "Type", + "tags": [], + "label": "ActionConnector", + "description": [], + "signature": [ + "ActionResult" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 22 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ActionType", + "type": "Type", + "tags": [], + "label": "ActionType", + "description": [], + "signature": [ + "\"append\" | \"overwrite\" | \"nothing\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 22 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ActionTypeConnector", + "type": "Type", + "tags": [], + "label": "ActionTypeConnector", + "description": [], + "signature": [ + "ActionType" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 23 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllCommentsResponse", + "type": "Type", + "tags": [], + "label": "AllCommentsResponse", + "description": [], + "signature": [ + "(({ comment: string; type: CommentType.user; } & { associationType: AssociationType; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: AssociationType; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 135 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.APP_ID", + "type": "string", + "tags": [], + "label": "APP_ID", + "description": [], + "signature": [ + "\"cases\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 10 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AttributesTypeAlerts", + "type": "Type", + "tags": [], + "label": "AttributesTypeAlerts", + "description": [], + "signature": [ + "{ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: AssociationType; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 130 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_ALERTS_URL", + "type": "string", + "tags": [], + "label": "CASE_ALERTS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 34 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_COMMENT_DETAILS_URL", + "type": "string", + "tags": [], + "label": "CASE_COMMENT_DETAILS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 27 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_COMMENTS_URL", + "type": "string", + "tags": [], + "label": "CASE_COMMENTS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 26 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_CONFIGURE_CONNECTORS_URL", + "type": "string", + "tags": [], + "label": "CASE_CONFIGURE_CONNECTORS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 19 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_CONFIGURE_URL", + "type": "string", + "tags": [], + "label": "CASE_CONFIGURE_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 18 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_DETAILS_URL", + "type": "string", + "tags": [], + "label": "CASE_DETAILS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 17 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_PUSH_URL", + "type": "string", + "tags": [], + "label": "CASE_PUSH_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 28 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_REPORTERS_URL", + "type": "string", + "tags": [], + "label": "CASE_REPORTERS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 29 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_STATUS_URL", + "type": "string", + "tags": [], + "label": "CASE_STATUS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 30 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_TAGS_URL", + "type": "string", + "tags": [], + "label": "CASE_TAGS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 31 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_USER_ACTIONS_URL", + "type": "string", + "tags": [], + "label": "CASE_USER_ACTIONS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 32 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseAttributes", + "type": "Type", + "tags": [], + "label": "CaseAttributes", + "description": [], + "signature": [ + "{ description: string; status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 175 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseConnector", + "type": "Type", + "tags": [], + "label": "CaseConnector", + "description": [], + "signature": [ + "{ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } | { id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } | { id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; } | { id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; } | { id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 82 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseField", + "type": "Type", + "tags": [], + "label": "CaseField", + "description": [], + "signature": [ + "\"description\" | \"title\" | \"comments\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 23 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseFullExternalService", + "type": "Type", + "tags": [], + "label": "CaseFullExternalService", + "description": [], + "signature": [ + "null | { connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 189 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasePatchRequest", + "type": "Type", + "tags": [], + "label": "CasePatchRequest", + "description": [], + "signature": [ + "{ description?: string | undefined; status?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + " | undefined; tags?: string[] | undefined; title?: string | undefined; type?: CaseType | undefined; connector?: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 187 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasePostRequest", + "type": "Type", + "tags": [], + "label": "CasePostRequest", + "description": [], + "signature": [ + "{ type?: CaseType | undefined; } & { description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 182 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseResponse", + "type": "Type", + "tags": [], + "label": "CaseResponse", + "description": [], + "signature": [ + "{ description: string; status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 183 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASES_URL", + "type": "string", + "tags": [], + "label": "CASES_URL", + "description": [ + "\nCase routes" + ], + "signature": [ + "\"/api/cases\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 16 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesClientPostRequest", + "type": "Type", + "tags": [], + "label": "CasesClientPostRequest", + "description": [ + "\nThis field differs from the CasePostRequest in that the post request's type field can be optional. This type requires\nthat the type field be defined. The CasePostRequest should be used in most places (the UI etc). This type is really\nonly necessary for validation." + ], + "signature": [ + "{ type: CaseType; description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 181 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigure", + "type": "Type", + "tags": [], + "label": "CasesConfigure", + "description": [], + "signature": [ + "{ connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 47 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigureAttributes", + "type": "Type", + "tags": [], + "label": "CasesConfigureAttributes", + "description": [], + "signature": [ + "{ connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 50 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigurePatch", + "type": "Type", + "tags": [], + "label": "CasesConfigurePatch", + "description": [], + "signature": [ + "{ connector?: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 49 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigureRequest", + "type": "Type", + "tags": [], + "label": "CasesConfigureRequest", + "description": [], + "signature": [ + "{ connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 48 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigureResponse", + "type": "Type", + "tags": [], + "label": "CasesConfigureResponse", + "description": [], + "signature": [ + "{ connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 51 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseSettings", + "type": "Type", + "tags": [], + "label": "CaseSettings", + "description": [], + "signature": [ + "{ syncAlerts: boolean; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 190 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesFindRequest", + "type": "Type", + "tags": [], + "label": "CasesFindRequest", + "description": [], + "signature": [ + "{ type?: CaseType | undefined; tags?: string | string[] | undefined; status?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + " | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string[] | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 185 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesFindResponse", + "type": "Type", + "tags": [], + "label": "CasesFindResponse", + "description": [], + "signature": [ + "{ cases: ({ description: string; status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 186 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesPatchRequest", + "type": "Type", + "tags": [], + "label": "CasesPatchRequest", + "description": [], + "signature": [ + "{ cases: ({ description?: string | undefined; status?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + " | undefined; tags?: string[] | undefined; title?: string | undefined; type?: CaseType | undefined; connector?: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 188 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesResponse", + "type": "Type", + "tags": [], + "label": "CasesResponse", + "description": [], + "signature": [ + "({ description: string; status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 184 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesStatusResponse", + "type": "Type", + "tags": [], + "label": "CasesStatusResponse", + "description": [], + "signature": [ + "{ count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 30 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.caseStatuses", + "type": "Array", + "tags": [], + "label": "caseStatuses", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 22 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseStatusWithAllStatus", + "type": "Type", + "tags": [], + "label": "CaseStatusWithAllStatus", + "description": [], + "signature": [ + "\"all\" | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open | typeof ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "[\"in-progress\"] | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 24 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.caseTypeField", + "type": "string", + "tags": [], + "label": "caseTypeField", + "description": [ + "\nExposing the field used to define the case type so that it can be used for filtering in saved object find queries." + ], + "signature": [ + "\"type\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 25 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActionAttributes", + "type": "Type", + "tags": [], + "label": "CaseUserActionAttributes", + "description": [], + "signature": [ + "{ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 59 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActionsResponse", + "type": "Type", + "tags": [], + "label": "CaseUserActionsResponse", + "description": [], + "signature": [ + "({ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; })[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 60 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ClosureType", + "type": "Type", + "tags": [], + "label": "ClosureType", + "description": [], + "signature": [ + "\"close-by-user\" | \"close-by-pushing\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 46 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Comment", + "type": "Type", + "tags": [], + "label": "Comment", + "description": [], + "signature": [ + "{ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; id: string; createdAt: string; createdBy: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ElasticUser", + "text": "ElasticUser" + }, + "; pushedAt: string | null; pushedBy: string | null; updatedAt: string | null; updatedBy: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ElasticUser", + "text": "ElasticUser" + }, + " | null; version: string; } | { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 26 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentAttributes", + "type": "Type", + "tags": [], + "label": "CommentAttributes", + "description": [], + "signature": [ + "{ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } | { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 131 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentPatchAttributes", + "type": "Type", + "tags": [], + "label": "CommentPatchAttributes", + "description": [], + "signature": [ + "{ associationType?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + " | undefined; created_at?: string | undefined; created_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | undefined; pushed_at?: string | null | undefined; pushed_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; updated_at?: string | null | undefined; updated_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; } | { type?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert | undefined; alertId?: string | string[] | undefined; index?: string | string[] | undefined; rule?: { id: string | null; name: string | null; } | undefined; } & { associationType?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + " | undefined; created_at?: string | undefined; created_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | undefined; pushed_at?: string | null | undefined; pushed_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; updated_at?: string | null | undefined; updated_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 138 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentPatchRequest", + "type": "Type", + "tags": [], + "label": "CommentPatchRequest", + "description": [], + "signature": [ + "{ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; } & { id: string; version: string; } | { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { id: string; version: string; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 137 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentRequest", + "type": "Type", + "tags": [], + "label": "CommentRequest", + "description": [], + "signature": [ + "{ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; } | { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 132 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentRequestAlertType", + "type": "Type", + "tags": [], + "label": "CommentRequestAlertType", + "description": [], + "signature": [ + "{ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 140 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentRequestUserType", + "type": "Type", + "tags": [], + "label": "CommentRequestUserType", + "description": [], + "signature": [ + "{ comment: string; type: CommentType.user; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 139 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentResponse", + "type": "Type", + "tags": [], + "label": "CommentResponse", + "description": [], + "signature": [ + "{ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; } | { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 133 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentResponseAlertsType", + "type": "Type", + "tags": [], + "label": "CommentResponseAlertsType", + "description": [], + "signature": [ + "{ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: AssociationType; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 134 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentsResponse", + "type": "Type", + "tags": [], + "label": "CommentsResponse", + "description": [], + "signature": [ + "{ comments: (({ comment: string; type: CommentType.user; } & { associationType: AssociationType; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: AssociationType; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[]; page: number; per_page: number; total: number; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 136 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorField", + "type": "Type", + "tags": [], + "label": "ConnectorField", + "description": [], + "signature": [ + "{ id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 48 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorFields", + "type": "Type", + "tags": [], + "label": "ConnectorFields", + "description": [], + "signature": [ + "null | { issueType: string | null; priority: string | null; parent: string | null; } | { incidentTypes: string[] | null; severityCode: string | null; } | { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 92 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorJiraTypeFields", + "type": "Type", + "tags": [], + "label": "ConnectorJiraTypeFields", + "description": [], + "signature": [ + "{ type: ConnectorTypes.jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 84 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorMappings", + "type": "Type", + "tags": [], + "label": "ConnectorMappings", + "description": [], + "signature": [ + "{ mappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 37 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorMappingsAttributes", + "type": "Type", + "tags": [], + "label": "ConnectorMappingsAttributes", + "description": [], + "signature": [ + "{ action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 36 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorResillientTypeFields", + "type": "Type", + "tags": [], + "label": "ConnectorResillientTypeFields", + "description": [], + "signature": [ + "{ type: ConnectorTypes.resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 85 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorServiceNowITSMTypeFields", + "type": "Type", + "tags": [], + "label": "ConnectorServiceNowITSMTypeFields", + "description": [], + "signature": [ + "{ type: ConnectorTypes.serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 86 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorServiceNowSIRTypeFields", + "type": "Type", + "tags": [], + "label": "ConnectorServiceNowSIRTypeFields", + "description": [], + "signature": [ + "{ type: ConnectorTypes.serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 89 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorTypeFields", + "type": "Type", + "tags": [], + "label": "ConnectorTypeFields", + "description": [], + "signature": [ + "{ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } | { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } | { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; } | { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; } | { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 83 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.DEFAULT_DATE_FORMAT", + "type": "string", + "tags": [], + "label": "DEFAULT_DATE_FORMAT", + "description": [], + "signature": [ + "\"dateFormat\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 7 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.DEFAULT_DATE_FORMAT_TZ", + "type": "string", + "tags": [], + "label": "DEFAULT_DATE_FORMAT_TZ", + "description": [], + "signature": [ + "\"dateFormat:tz\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 8 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ENABLE_CASE_CONNECTOR", + "type": "boolean", + "tags": [], + "label": "ENABLE_CASE_CONNECTOR", + "description": [ + "\nThis flag governs enabling the case as a connector feature. It is disabled by default as the feature is not complete." + ], + "signature": [ + "false" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 63 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCaseAttributes", + "type": "Type", + "tags": [], + "label": "ESCaseAttributes", + "description": [], + "signature": [ + "Pick<{ description: string; status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 193 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCaseConnectorTypes", + "type": "Type", + "tags": [], + "label": "ESCaseConnectorTypes", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 99 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCasePatchRequest", + "type": "Type", + "tags": [], + "label": "ESCasePatchRequest", + "description": [], + "signature": [ + "Pick<{ description?: string | undefined; status?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + " | undefined; tags?: string[] | undefined; title?: string | undefined; type?: CaseType | undefined; connector?: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 194 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCasesConfigureAttributes", + "type": "Type", + "tags": [], + "label": "ESCasesConfigureAttributes", + "description": [], + "signature": [ + "Pick<{ connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 53 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESConnectorFields", + "type": "Type", + "tags": [], + "label": "ESConnectorFields", + "description": [], + "signature": [ + "{ key: string; value: unknown; }[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 94 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ExternalServiceResponse", + "type": "Type", + "tags": [], + "label": "ExternalServiceResponse", + "description": [], + "signature": [ + "{ title: string; id: string; pushedDate: string; url: string; } & { comments?: ({ commentId: string; pushedDate: string; } & { externalCommentId?: string | undefined; })[] | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 191 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.GetCaseIdsByAlertIdAggs", + "type": "Type", + "tags": [], + "label": "GetCaseIdsByAlertIdAggs", + "description": [], + "signature": [ + "{ references: { doc_count: number; caseIds: { buckets: { key: string; }[]; }; }; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 141 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.GetFieldsResponse", + "type": "Type", + "tags": [], + "label": "GetFieldsResponse", + "description": [], + "signature": [ + "{ defaultMappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; fields: { id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }[]; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 55 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.JIRA_ACTION_TYPE_ID", + "type": "string", + "tags": [], + "label": "JIRA_ACTION_TYPE_ID", + "description": [], + "signature": [ + "\".jira\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 44 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.JiraFieldsType", + "type": "Type", + "tags": [], + "label": "JiraFieldsType", + "description": [], + "signature": [ + "{ issueType: string | null; priority: string | null; parent: string | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", + "lineNumber": 17 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.MAX_ALERTS_PER_SUB_CASE", + "type": "number", + "tags": [], + "label": "MAX_ALERTS_PER_SUB_CASE", + "description": [ + "\nAlerts" + ], + "signature": [ + "5000" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 57 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.MAX_GENERATED_ALERTS_PER_SUB_CASE", + "type": "number", + "tags": [], + "label": "MAX_GENERATED_ALERTS_PER_SUB_CASE", + "description": [], + "signature": [ + "50" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 58 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.RESILIENT_ACTION_TYPE_ID", + "type": "string", + "tags": [], + "label": "RESILIENT_ACTION_TYPE_ID", + "description": [], + "signature": [ + "\".resilient\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 45 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ResilientFieldsType", + "type": "Type", + "tags": [], + "label": "ResilientFieldsType", + "description": [], + "signature": [ + "{ incidentTypes: string[] | null; severityCode: string | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", + "lineNumber": 16 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SavedObjectFindOptions", + "type": "Type", + "tags": [], + "label": "SavedObjectFindOptions", + "description": [], + "signature": [ + "{ defaultSearchOperator?: \"AND\" | \"OR\" | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; hasReference?: { id: string; type: string; } | { id: string; type: string; }[] | undefined; fields?: string[] | undefined; filter?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/saved_object.ts", + "lineNumber": 39 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SERVICENOW_ITSM_ACTION_TYPE_ID", + "type": "string", + "tags": [], + "label": "SERVICENOW_ITSM_ACTION_TYPE_ID", + "description": [], + "signature": [ + "\".servicenow\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 42 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SERVICENOW_SIR_ACTION_TYPE_ID", + "type": "string", + "tags": [], + "label": "SERVICENOW_SIR_ACTION_TYPE_ID", + "description": [], + "signature": [ + "\".servicenow-sir\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 43 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ServiceNowITSMFieldsType", + "type": "Type", + "tags": [], + "label": "ServiceNowITSMFieldsType", + "description": [], + "signature": [ + "{ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", + "lineNumber": 19 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ServiceNowSIRFieldsType", + "type": "Type", + "tags": [], + "label": "ServiceNowSIRFieldsType", + "description": [], + "signature": [ + "{ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", + "lineNumber": 21 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.StatusAll", + "type": "string", + "tags": [], + "label": "StatusAll", + "description": [], + "signature": [ + "\"all\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 21 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.StatusAllType", + "type": "Type", + "tags": [], + "label": "StatusAllType", + "description": [], + "signature": [ + "\"all\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 22 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SUB_CASE_DETAILS_URL", + "type": "string", + "tags": [], + "label": "SUB_CASE_DETAILS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 23 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SUB_CASE_USER_ACTIONS_URL", + "type": "string", + "tags": [], + "label": "SUB_CASE_USER_ACTIONS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 24 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SUB_CASES_PATCH_DEL_URL", + "type": "string", + "tags": [], + "label": "SUB_CASES_PATCH_DEL_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 21 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SUB_CASES_URL", + "type": "string", + "tags": [], + "label": "SUB_CASES_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 22 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCaseAttributes", + "type": "Type", + "tags": [], + "label": "SubCaseAttributes", + "description": [], + "signature": [ + "{ status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 75 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasePatchRequest", + "type": "Type", + "tags": [], + "label": "SubCasePatchRequest", + "description": [], + "signature": [ + "{ status?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + " | undefined; } & { id: string; version: string; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 79 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCaseResponse", + "type": "Type", + "tags": [], + "label": "SubCaseResponse", + "description": [], + "signature": [ + "{ status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 76 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesFindResponse", + "type": "Type", + "tags": [], + "label": "SubCasesFindResponse", + "description": [], + "signature": [ + "{ subCases: ({ status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 78 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesPatchRequest", + "type": "Type", + "tags": [], + "label": "SubCasesPatchRequest", + "description": [], + "signature": [ + "{ subCases: ({ status?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + " | undefined; } & { id: string; version: string; })[]; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 80 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesResponse", + "type": "Type", + "tags": [], + "label": "SubCasesResponse", + "description": [], + "signature": [ + "({ status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 77 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SUPPORTED_CONNECTORS", + "type": "Array", + "tags": [], + "label": "SUPPORTED_CONNECTORS", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 47 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ThirdPartyField", + "type": "Type", + "tags": [], + "label": "ThirdPartyField", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 24 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateKey", + "type": "Type", + "tags": [], + "label": "UpdateKey", + "description": [], + "signature": [ + "\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 163 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.User", + "type": "Type", + "tags": [], + "label": "User", + "description": [], + "signature": [ + "{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/user.ts", + "lineNumber": 18 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UserAction", + "type": "Type", + "tags": [], + "label": "UserAction", + "description": [], + "signature": [ + "\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 62 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UserActionField", + "type": "Type", + "tags": [], + "label": "UserActionField", + "description": [], + "signature": [ + "(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 63 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UserActionFieldType", + "type": "Type", + "tags": [], + "label": "UserActionFieldType", + "description": [], + "signature": [ + "\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 64 + }, + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "cases", + "id": "def-common.AlertCommentRequestRt", + "type": "Object", + "tags": [], + "label": "AlertCommentRequestRt", + "description": [ + "\nThis defines the structure of how alerts (generated or user attached) are stored in saved objects documents. It also\nrepresents of an alert after it has been transformed. A generated alert will be transformed by the connector so that\nit matches this structure. User attached alerts do not need to be transformed." + ], + "signature": [ + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 67 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllCommentsResponseRt", + "type": "Object", + "tags": [], + "label": "AllCommentsResponseRt", + "description": [], + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 128 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllCommentsResponseRT", + "type": "Object", + "tags": [], + "label": "AllCommentsResponseRT", + "description": [], + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 99 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseAttributesRt", + "type": "Object", + "tags": [], + "label": "CaseAttributesRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC", + "<[", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 62 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseConfigureAttributesRt", + "type": "Object", + "tags": [], + "label": "CaseConfigureAttributesRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 27 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseConfigureResponseRt", + "type": "Object", + "tags": [], + "label": "CaseConfigureResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 37 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseConnectorRt", + "type": "Object", + "tags": [], + "label": "CaseConnectorRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 74 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasePatchRequestRt", + "type": "Object", + "tags": [], + "label": "CasePatchRequestRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC", + "<[", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 142 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasePostRequestRt", + "type": "Object", + "tags": [], + "label": "CasePostRequestRt", + "description": [ + "\nThis type is not used for validation when decoding a request because intersection does not have props defined which\nrequired for the excess function. Instead we use this as the type used by the UI. This allows the type field to be\noptional and the server will handle setting it to a default value before validating that the request\nhas all the necessary fields. CasesClientPostRequestRt is used for validation." + ], + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 97 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasePushRequestParamsRt", + "type": "Object", + "tags": [], + "label": "CasePushRequestParamsRt", + "description": [], + "signature": [ + "TypeC", + "<{ case_id: ", + "StringC", + "; connector_id: ", + "StringC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 150 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseResponseRt", + "type": "Object", + "tags": [], + "label": "CaseResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 117 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesClientPostRequestRt", + "type": "Object", + "tags": [], + "label": "CasesClientPostRequestRt", + "description": [ + "\nThis type is used for validating a create case request. It requires that the type field be defined." + ], + "signature": [ + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 86 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigurePatchRt", + "type": "Object", + "tags": [], + "label": "CasesConfigurePatchRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 22 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigureRequestRt", + "type": "Object", + "tags": [], + "label": "CasesConfigureRequestRt", + "description": [], + "signature": [ + "TypeC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 21 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesFindRequestRt", + "type": "Object", + "tags": [], + "label": "CasesFindRequestRt", + "description": [], + "signature": [ + "PartialC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 102 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesFindResponseRt", + "type": "Object", + "tags": [], + "label": "CasesFindResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ cases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 132 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesPatchRequestRt", + "type": "Object", + "tags": [], + "label": "CasesPatchRequestRt", + "description": [], + "signature": [ + "TypeC", + "<{ cases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "PartialC", + "<{ description: ", + "StringC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 147 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesResponseRt", + "type": "Object", + "tags": [], + "label": "CasesResponseRt", + "description": [], + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ description: ", + "StringC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 148 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesStatusResponseRt", + "type": "Object", + "tags": [], + "label": "CasesStatusResponseRt", + "description": [], + "signature": [ + "TypeC", + "<{ count_open_cases: ", + "NumberC", + "; count_in_progress_cases: ", + "NumberC", + "; count_closed_cases: ", + "NumberC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 24 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseStatusRt", + "type": "Object", + "tags": [], + "label": "CaseStatusRt", + "description": [], + "signature": [ + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 55 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActionsResponseRt", + "type": "Object", + "tags": [], + "label": "CaseUserActionsResponseRt", + "description": [], + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "TypeC", + "<{ action_field: ", + "ArrayC", + "<", + "UnionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 57 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentAttributesBasicRt", + "type": "Object", + "tags": [], + "label": "CommentAttributesBasicRt", + "description": [], + "signature": [ + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 38 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentPatchAttributesRt", + "type": "Object", + "tags": [], + "label": "CommentPatchAttributesRt", + "description": [ + "\nThis type is used by the CaseService.\nBecause the type for the attributes of savedObjectClient update function is Partial\nwe need to make all of our attributes partial too.\nWe ensure that partial updates of CommentContext is not going to happen inside the patch comment route." + ], + "signature": [ + "IntersectionC", + "<[", + "UnionC", + "<[", + "PartialC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 116 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentPatchRequestRt", + "type": "Object", + "tags": [], + "label": "CommentPatchRequestRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "UnionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 101 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentRequestRt", + "type": "Object", + "tags": [], + "label": "CommentRequestRt", + "description": [], + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 81 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentResponseRt", + "type": "Object", + "tags": [], + "label": "CommentResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 83 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentResponseTypeAlertsRt", + "type": "Object", + "tags": [], + "label": "CommentResponseTypeAlertsRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 91 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentsResponseRt", + "type": "Object", + "tags": [], + "label": "CommentsResponseRt", + "description": [], + "signature": [ + "TypeC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 121 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorFieldsRt", + "type": "Object", + "tags": [], + "label": "ConnectorFieldsRt", + "description": [], + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 25 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorMappingsAttributesRT", + "type": "Object", + "tags": [], + "label": "ConnectorMappingsAttributesRT", + "description": [], + "signature": [ + "TypeC", + "<{ action_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"append\">, ", + "LiteralC", + "<\"nothing\">, ", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 26 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorMappingsRt", + "type": "Object", + "tags": [], + "label": "ConnectorMappingsRt", + "description": [], + "signature": [ + "TypeC", + "<{ mappings: ", + "ArrayC", + "<", + "TypeC", + "<{ action_type: ", + "UnionC", + "<[", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 32 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorTypeFieldsRt", + "type": "Object", + "tags": [], + "label": "ConnectorTypeFieldsRt", + "description": [], + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 66 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ContextTypeUserRt", + "type": "Object", + "tags": [], + "label": "ContextTypeUserRt", + "description": [], + "signature": [ + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 57 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ExternalServiceResponseRt", + "type": "Object", + "tags": [], + "label": "ExternalServiceResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ title: ", + "StringC", + "; id: ", + "StringC", + "; pushedDate: ", + "StringC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 155 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.GetCaseIdsByAlertIdAggsRt", + "type": "Object", + "tags": [], + "label": "GetCaseIdsByAlertIdAggsRt", + "description": [], + "signature": [ + "TypeC", + "<{ references: ", + "TypeC", + "<{ doc_count: ", + "NumberC", + "; caseIds: ", + "TypeC", + "<{ buckets: ", + "ArrayC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 18 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.JiraFieldsRT", + "type": "Object", + "tags": [], + "label": "JiraFieldsRT", + "description": [], + "signature": [ + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", + "lineNumber": 11 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.NumberFromString", + "type": "Object", + "tags": [], + "label": "NumberFromString", + "description": [], + "signature": [ + "Type", + "" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/saved_object.ts", + "lineNumber": 12 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ResilientFieldsRT", + "type": "Object", + "tags": [], + "label": "ResilientFieldsRT", + "description": [], + "signature": [ + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", + "lineNumber": 11 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SavedObjectFindOptionsRt", + "type": "Object", + "tags": [], + "label": "SavedObjectFindOptionsRt", + "description": [], + "signature": [ + "PartialC", + "<{ defaultSearchOperator: ", + "UnionC", + "<[", + "LiteralC", + "<\"AND\">, ", + "LiteralC", + "<\"OR\">]>; hasReferenceOperator: ", + "UnionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/saved_object.ts", + "lineNumber": 25 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ServiceNowITSMFieldsRT", + "type": "Object", + "tags": [], + "label": "ServiceNowITSMFieldsRT", + "description": [], + "signature": [ + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", + "lineNumber": 11 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ServiceNowSIRFieldsRT", + "type": "Object", + "tags": [], + "label": "ServiceNowSIRFieldsRT", + "description": [], + "signature": [ + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", + "lineNumber": 11 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCaseAttributesRt", + "type": "Object", + "tags": [], + "label": "SubCaseAttributesRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 20 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasePatchRequestRt", + "type": "Object", + "tags": [], + "label": "SubCasePatchRequestRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 67 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCaseResponseRt", + "type": "Object", + "tags": [], + "label": "SubCaseResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 44 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesFindRequestRt", + "type": "Object", + "tags": [], + "label": "SubCasesFindRequestRt", + "description": [], + "signature": [ + "PartialC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 32 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesFindResponseRt", + "type": "Object", + "tags": [], + "label": "SubCasesFindResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ subCases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 57 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesPatchRequestRt", + "type": "Object", + "tags": [], + "label": "SubCasesPatchRequestRt", + "description": [], + "signature": [ + "TypeC", + "<{ subCases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "PartialC", + "<{ status: ", + "UnionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 72 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesResponseRt", + "type": "Object", + "tags": [], + "label": "SubCasesResponseRt", + "description": [], + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 73 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UserRT", + "type": "Object", + "tags": [], + "label": "UserRT", + "description": [], + "signature": [ + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/user.ts", + "lineNumber": 10 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UsersRt", + "type": "Object", + "tags": [], + "label": "UsersRt", + "description": [], + "signature": [ + "ArrayC", + "<", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/user.ts", + "lineNumber": 16 + }, + "deprecated": false, + "initialIsOpen": false + } + ] } } \ No newline at end of file diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 36429f257d357..892e3e02e7522 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -11,8 +11,39 @@ warning: This document is auto-generated and is meant to be viewed inside our ex import casesObj from './cases.json'; +## Client + +### Start + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + ## Server ### Interfaces +## Common + +### Objects + + +### Functions + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/charts.json b/api_docs/charts.json index 9bc9b559cee6e..0195d0b72b1b6 100644 --- a/api_docs/charts.json +++ b/api_docs/charts.json @@ -4,222 +4,291 @@ "classes": [], "functions": [ { + "parentPluginId": "charts", "id": "def-public.ColorPicker", "type": "Function", + "tags": [], + "label": "ColorPicker", + "description": [], + "signature": [ + "({ onChange, color: selectedColor, label, useLegacyColors, colorIsOverwritten, onKeyDown, }: ColorPickerProps) => JSX.Element" + ], + "source": { + "path": "src/plugins/charts/public/static/components/color_picker.tsx", + "lineNumber": 111 + }, + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.ColorPicker.$1", "type": "Object", + "tags": [], "label": "{\n onChange,\n color: selectedColor,\n label,\n useLegacyColors = true,\n colorIsOverwritten = true,\n onKeyDown,\n}", - "isRequired": true, + "description": [], "signature": [ "ColorPickerProps" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/color_picker.tsx", "lineNumber": 111 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ onChange, color: selectedColor, label, useLegacyColors, colorIsOverwritten, onKeyDown, }: ColorPickerProps) => JSX.Element" - ], - "description": [], - "label": "ColorPicker", - "source": { - "path": "src/plugins/charts/public/static/components/color_picker.tsx", - "lineNumber": 111 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.createColorPalette", "type": "Function", + "tags": [], "label": "createColorPalette", - "signature": [ - "(num: number) => string[]" - ], "description": [ "\nGenerates an array of hex colors the length of the input number.\nIf the number is greater than the length of seed colors available,\nnew colors are generated up to the value of the input number." ], + "signature": [ + "(num: number) => string[]" + ], + "source": { + "path": "src/plugins/charts/public/static/colors/color_palette.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.createColorPalette.$1", "type": "number", + "tags": [], "label": "num", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/colors/color_palette.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/charts/public/static/colors/color_palette.ts", - "lineNumber": 41 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.CurrentTime", "type": "Function", + "tags": [], + "label": "CurrentTime", + "description": [ + "\nRender current time line annotation on @elastic/charts `Chart`" + ], + "signature": [ + "({ isDarkMode, domainEnd }: React.PropsWithChildren) => JSX.Element" + ], + "source": { + "path": "src/plugins/charts/public/static/components/current_time.tsx", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.CurrentTime.$1", "type": "CompoundType", + "tags": [], "label": "{ isDarkMode, domainEnd }", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/current_time.tsx", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ isDarkMode, domainEnd }: React.PropsWithChildren) => JSX.Element" - ], - "description": [ - "\nRender current time line annotation on @elastic/charts `Chart`" - ], - "label": "CurrentTime", - "source": { - "path": "src/plugins/charts/public/static/components/current_time.tsx", - "lineNumber": 24 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.Endzones", "type": "Function", + "tags": [], + "label": "Endzones", + "description": [], + "signature": [ + "({ isDarkMode, domainStart, domainEnd, interval, domainMin, domainMax, hideTooltips, isFullBin, }: React.PropsWithChildren) => JSX.Element" + ], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.Endzones.$1", "type": "CompoundType", + "tags": [], "label": "{\n isDarkMode,\n domainStart,\n domainEnd,\n interval,\n domainMin,\n domainMax,\n hideTooltips = true,\n isFullBin = false,\n}", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 37 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ isDarkMode, domainStart, domainEnd, interval, domainMin, domainMax, hideTooltips, isFullBin, }: React.PropsWithChildren) => JSX.Element" - ], - "description": [], - "label": "Endzones", - "source": { - "path": "src/plugins/charts/public/static/components/endzones.tsx", - "lineNumber": 37 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.getAdjustedInterval", "type": "Function", + "tags": [], + "label": "getAdjustedInterval", + "description": [ + "\nReturns the adjusted interval based on the data\n" + ], + "signature": [ + "(xValues: number[], esValue: number, esUnit: moment.unitOfTime.Base, timeZone: string) => number" + ], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 120 + }, + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.getAdjustedInterval.$1", "type": "Array", + "tags": [], "label": "xValues", - "isRequired": true, + "description": [], "signature": [ "number[]" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 121 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "charts", "id": "def-public.getAdjustedInterval.$2", "type": "number", + "tags": [], "label": "esValue", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 122 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "charts", "id": "def-public.getAdjustedInterval.$3", "type": "CompoundType", + "tags": [], "label": "esUnit", - "isRequired": true, + "description": [], "signature": [ "moment.unitOfTime.Base" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 123 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "charts", "id": "def-public.getAdjustedInterval.$4", "type": "string", + "tags": [], "label": "timeZone", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 124 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(xValues: number[], esValue: number, esUnit: moment.unitOfTime.Base, timeZone: string) => number" - ], - "description": [ - "\nReturns the adjusted interval based on the data\n" - ], - "label": "getAdjustedInterval", - "source": { - "path": "src/plugins/charts/public/static/components/endzones.tsx", - "lineNumber": 120 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.getBrushFromChartBrushEventFn", "type": "Function", + "tags": [], + "label": "getBrushFromChartBrushEventFn", + "description": [ + "\nHelper function to transform `@elastic/charts` brush event into brush action event" + ], + "signature": [ + "(table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", xAccessor: string | number | ", + "AccessorFn", + ") => ({ x: selectedRange }: ", + "XYBrushArea", + ") => ", + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.BrushTriggerEvent", + "text": "BrushTriggerEvent" + } + ], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 254 + }, + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.getBrushFromChartBrushEventFn.$1", "type": "Object", + "tags": [], "label": "table", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -229,28 +298,44 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 255 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "charts", "id": "def-public.getBrushFromChartBrushEventFn.$2", "type": "CompoundType", + "tags": [], "label": "xAccessor", - "isRequired": true, + "description": [], "signature": [ "string | number | ", "AccessorFn" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 256 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "charts", + "id": "def-public.getFilterFromChartClickEventFn", + "type": "Function", + "tags": [], + "label": "getFilterFromChartClickEventFn", + "description": [ + "\nHelper function to transform `@elastic/charts` click event into filter action event\n" + ], "signature": [ "(table: ", { @@ -262,38 +347,26 @@ }, ", xAccessor: string | number | ", "AccessorFn", - ") => ({ x: selectedRange }: ", - "XYBrushArea", - ") => ", - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.BrushTriggerEvent", - "text": "BrushTriggerEvent" - } - ], - "description": [ - "\nHelper function to transform `@elastic/charts` brush event into brush action event" + ", splitSeriesAccessorFnMap?: Map | undefined, splitChartAccessor?: string | number | ", + "AccessorFn", + " | undefined, negate?: boolean) => (points: [", + "GeometryValue" ], - "label": "getBrushFromChartBrushEventFn", "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", - "lineNumber": 254 + "lineNumber": 171 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.getFilterFromChartClickEventFn", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.getFilterFromChartClickEventFn.$1", "type": "Object", + "tags": [], "label": "table", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -303,128 +376,98 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 172 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "charts", "id": "def-public.getFilterFromChartClickEventFn.$2", "type": "CompoundType", + "tags": [], "label": "xAccessor", - "isRequired": true, + "description": [], "signature": [ "string | number | ", "AccessorFn" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 173 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "charts", "id": "def-public.getFilterFromChartClickEventFn.$3", "type": "Object", + "tags": [], "label": "splitSeriesAccessorFnMap", - "isRequired": false, + "description": [], "signature": [ "Map | undefined" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 174 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "charts", "id": "def-public.getFilterFromChartClickEventFn.$4", "type": "CompoundType", + "tags": [], "label": "splitChartAccessor", - "isRequired": false, + "description": [], "signature": [ "string | number | ", "AccessorFn", " | undefined" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 175 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "charts", "id": "def-public.getFilterFromChartClickEventFn.$5", "type": "boolean", + "tags": [], "label": "negate", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 176 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(table: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - ", xAccessor: string | number | ", - "AccessorFn", - ", splitSeriesAccessorFnMap?: Map | undefined, splitChartAccessor?: string | number | ", - "AccessorFn", - " | undefined, negate?: boolean) => (points: [", - "GeometryValue" - ], - "description": [ - "\nHelper function to transform `@elastic/charts` click event into filter action event\n" - ], - "label": "getFilterFromChartClickEventFn", - "source": { - "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", - "lineNumber": 171 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.getFilterFromSeriesFn", "type": "Function", - "children": [ - { - "id": "def-public.getFilterFromSeriesFn.$1", - "type": "Object", - "label": "table", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "description": [], - "source": { - "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", - "lineNumber": 220 - } - } + "tags": [], + "label": "getFilterFromSeriesFn", + "description": [ + "\nHelper function to get filter action event from series" ], "signature": [ "(table: ", @@ -447,205 +490,258 @@ "scope": "public", "docId": "kibChartsPluginApi", "section": "def-public.ClickTriggerEvent", - "text": "ClickTriggerEvent" - } - ], - "description": [ - "\nHelper function to get filter action event from series" + "text": "ClickTriggerEvent" + } ], - "label": "getFilterFromSeriesFn", "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 220 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "charts", + "id": "def-public.getFilterFromSeriesFn.$1", + "type": "Object", + "tags": [], + "label": "table", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 220 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.getHeatmapColors", "type": "Function", + "tags": [], "label": "getHeatmapColors", + "description": [], "signature": [ "(value: any, colorSchemaName: string) => string" ], - "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.getHeatmapColors.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "charts", "id": "def-public.getHeatmapColors.$2", "type": "string", + "tags": [], "label": "colorSchemaName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", - "lineNumber": 47 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.LegendToggle", "type": "Function", + "tags": [], "label": "LegendToggle", "description": [], + "signature": [ + "React.MemoExoticComponent<({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element>" + ], "source": { "path": "src/plugins/charts/public/static/components/legend_toggle.tsx", "lineNumber": 51 }, - "signature": [ - "React.MemoExoticComponent<({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.renderEndzoneTooltip", "type": "Function", + "tags": [], + "label": "renderEndzoneTooltip", + "description": [], + "signature": [ + "(xInterval?: number | undefined, domainStart?: number | undefined, domainEnd?: number | undefined, formatter?: ((v: any) => string) | undefined, renderValue?: boolean) => (headerData: ", + "TooltipValue", + ") => string | JSX.Element" + ], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 159 + }, + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.renderEndzoneTooltip.$1", "type": "number", + "tags": [], "label": "xInterval", - "isRequired": false, + "description": [], "signature": [ "number | undefined" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 160 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "charts", "id": "def-public.renderEndzoneTooltip.$2", "type": "number", + "tags": [], "label": "domainStart", - "isRequired": false, + "description": [], "signature": [ "number | undefined" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 161 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "charts", "id": "def-public.renderEndzoneTooltip.$3", "type": "number", + "tags": [], "label": "domainEnd", - "isRequired": false, + "description": [], "signature": [ "number | undefined" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 162 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "charts", "id": "def-public.renderEndzoneTooltip.$4", "type": "Function", + "tags": [], "label": "formatter", - "isRequired": false, + "description": [], "signature": [ "((v: any) => string) | undefined" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 163 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "charts", "id": "def-public.renderEndzoneTooltip.$5", "type": "boolean", + "tags": [], "label": "renderValue", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/charts/public/static/components/endzones.tsx", "lineNumber": 164 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(xInterval?: number | undefined, domainStart?: number | undefined, domainEnd?: number | undefined, formatter?: ((v: any) => string) | undefined, renderValue?: boolean) => (headerData: ", - "TooltipValue", - ") => string | JSX.Element" - ], - "description": [], - "label": "renderEndzoneTooltip", - "source": { - "path": "src/plugins/charts/public/static/components/endzones.tsx", - "lineNumber": 159 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "charts", "id": "def-public.BrushTriggerEvent", "type": "Interface", + "tags": [], "label": "BrushTriggerEvent", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.BrushTriggerEvent.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"brush\"" + ], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 27 }, - "signature": [ - "\"brush\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.BrushTriggerEvent.data", "type": "Object", + "tags": [], "label": "data", "description": [], - "source": { - "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", - "lineNumber": 28 - }, "signature": [ "{ table: ", { @@ -656,126 +752,142 @@ "text": "Datatable" }, "; column: number; range: number[]; timeFieldName?: string | undefined; }" - ] + ], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 28 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.ChartColorConfiguration", "type": "Interface", + "tags": [], "label": "ChartColorConfiguration", "description": [ "\nInformation about the structure of a chart to determine the color of a series within it." ], - "tags": [], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ChartColorConfiguration.totalSeries", "type": "number", + "tags": [], "label": "totalSeries", "description": [ "\nOverall number of series in the current chart" ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 37 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ChartColorConfiguration.maxDepth", "type": "number", + "tags": [], "label": "maxDepth", "description": [ "\nMax nesting depth of the series tree" ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 41 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ChartColorConfiguration.behindText", "type": "CompoundType", + "tags": [], "label": "behindText", "description": [ "\nFlag whether the color will be used behind text. The palette can use this information to\nadjust colors for better a11y. Might be ignored depending on the palette." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 46 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ChartColorConfiguration.syncColors", "type": "CompoundType", + "tags": [], "label": "syncColors", "description": [ "\nFlag whether a color assignment to a given key should be remembered and re-used the next time the key shows up.\nThis setting might be ignored based on the palette." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 51 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 33 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.ClickTriggerEvent", "type": "Interface", + "tags": [], "label": "ClickTriggerEvent", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ClickTriggerEvent.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"filterBucket\"" + ], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "lineNumber": 22 }, - "signature": [ - "\"filterBucket\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ClickTriggerEvent.data", "type": "Object", + "tags": [], "label": "data", "description": [], - "source": { - "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", - "lineNumber": 23 - }, "signature": [ "{ data: { table: Pick<", { @@ -786,60 +898,68 @@ "text": "Datatable" }, ", \"rows\" | \"columns\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }" - ] + ], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 23 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.ColorMap", "type": "Interface", + "tags": [], "label": "ColorMap", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.ColorMap.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 32 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.ColorSchema", "type": "Interface", + "tags": [], "label": "ColorSchema", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ColorSchema.value", "type": "Enum", + "tags": [], "label": "value", "description": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 21 - }, "signature": [ { "pluginId": "charts", @@ -848,43 +968,49 @@ "section": "def-public.ColorSchemas", "text": "ColorSchemas" } - ] + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ColorSchema.text", "type": "string", + "tags": [], "label": "text", "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 22 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.ColorSchemaParams", "type": "Interface", + "tags": [], "label": "ColorSchemaParams", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ColorSchemaParams.colorSchema", "type": "Enum", + "tags": [], "label": "colorSchema", "description": [], - "source": { - "path": "src/plugins/charts/public/static/components/types.ts", - "lineNumber": 13 - }, "signature": [ { "pluginId": "charts", @@ -893,220 +1019,256 @@ "section": "def-public.ColorSchemas", "text": "ColorSchemas" } - ] + ], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 13 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ColorSchemaParams.invertColors", "type": "boolean", + "tags": [], "label": "invertColors", "description": [], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 14 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/static/components/types.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.CustomPaletteArguments", "type": "Interface", + "tags": [], "label": "CustomPaletteArguments", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.CustomPaletteArguments.color", "type": "Array", + "tags": [], "label": "color", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 14 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.CustomPaletteArguments.gradient", "type": "boolean", + "tags": [], "label": "gradient", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.CustomPaletteArguments.reverse", "type": "CompoundType", + "tags": [], "label": "reverse", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 16 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.CustomPaletteState", "type": "Interface", + "tags": [], "label": "CustomPaletteState", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.CustomPaletteState.colors", "type": "Array", + "tags": [], "label": "colors", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 20 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.CustomPaletteState.gradient", "type": "boolean", + "tags": [], "label": "gradient", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.Labels", "type": "Interface", + "tags": [], "label": "Labels", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Labels.color", "type": "string", + "tags": [], "label": "color", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Labels.filter", "type": "CompoundType", + "tags": [], "label": "filter", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 19 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Labels.overwriteColor", "type": "CompoundType", + "tags": [], "label": "overwriteColor", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 20 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Labels.rotate", "type": "number", + "tags": [], "label": "rotate", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 21 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Labels.show", "type": "CompoundType", + "tags": [], "label": "show", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 22 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Labels.truncate", "type": "CompoundType", + "tags": [], "label": "truncate", "description": [], + "signature": [ + "number | null | undefined" + ], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 23 }, - "signature": [ - "number | null | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/static/components/types.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.PaletteDefinition", "type": "Interface", + "tags": [], "label": "PaletteDefinition", + "description": [ + "\nDefinition of a global palette.\n\nA palette controls the appearance of Lens charts on an editor level.\nThe palette wont get reset when switching charts.\n\nA palette can hold internal state (e.g. for customizations) and also includes\nan editor component to edit the internal state." + ], "signature": [ { "pluginId": "charts", @@ -1117,15 +1279,17 @@ }, "" ], - "description": [ - "\nDefinition of a global palette.\n\nA palette controls the appearance of Lens charts on an editor level.\nThe palette wont get reset when switching charts.\n\nA palette can hold internal state (e.g. for customizations) and also includes\nan editor component to edit the internal state." - ], - "tags": [], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteDefinition.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nUnique id of the palette (this will be persisted along with the visualization state)" @@ -1133,12 +1297,14 @@ "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 67 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteDefinition.title", "type": "string", + "tags": [], "label": "title", "description": [ "\nUser facing title (should be i18n-ized)" @@ -1146,69 +1312,73 @@ "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 71 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteDefinition.internal", "type": "CompoundType", + "tags": [], "label": "internal", "description": [ "\nFlag indicating whether users should be able to pick this palette manually." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 75 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteDefinition.toExpression", "type": "Function", + "tags": [], "label": "toExpression", "description": [ "\nSerialize the internal state of the palette into an expression function.\nThis function should be used to pass the palette to the expression function applying color and other styles" ], + "signature": [ + "(state?: T | undefined) => ", + "Ast" + ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 81 }, - "signature": [ - "(state?: T | undefined) => ", - "Ast" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteDefinition.renderEditor", "type": "Function", + "tags": [], "label": "renderEditor", "description": [ "\nRenders the UI for editing the internal state of the palette.\nNot each palette has to feature an internal state, so this is an optional property." ], + "signature": [ + "((domElement: Element, props: { state?: T | undefined; setState: (updater: (oldState: T) => T) => void; }) => void) | undefined" + ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 88 }, - "signature": [ - "((domElement: Element, props: { state?: T | undefined; setState: (updater: (oldState: T) => T) => void; }) => void) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteDefinition.getColor", "type": "Function", + "tags": [], "label": "getColor", "description": [ "\nColor a series according to the internal rules of the palette." ], - "source": { - "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 97 - }, "signature": [ "(series: ", { @@ -1227,35 +1397,41 @@ "text": "ChartColorConfiguration" }, " | undefined, state?: T | undefined) => string | null" - ] + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 97 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteDefinition.getColors", "type": "Function", + "tags": [], "label": "getColors", "description": [ "\nGet a spectrum of colors of the current palette.\nThis can be used if the chart wants to control color assignment locally." ], + "signature": [ + "(size: number, state?: T | undefined) => string[]" + ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 106 }, - "signature": [ - "(size: number, state?: T | undefined) => string[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 63 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.PaletteOutput", "type": "Interface", + "tags": [], "label": "PaletteOutput", + "description": [], "signature": [ { "pluginId": "charts", @@ -1266,72 +1442,80 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteOutput.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"palette\"" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 29 }, - "signature": [ - "\"palette\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteOutput.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteOutput.params", "type": "Uncategorized", + "tags": [], "label": "params", "description": [], + "signature": [ + "T | undefined" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 31 }, - "signature": [ - "T | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.PaletteRegistry", "type": "Interface", + "tags": [], "label": "PaletteRegistry", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 109 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteRegistry.get", "type": "Function", + "tags": [], "label": "get", "description": [], - "source": { - "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 110 - }, "signature": [ "(name: string) => ", { @@ -1342,18 +1526,20 @@ "text": "PaletteDefinition" }, "" - ] + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 110 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.PaletteRegistry.getAll", "type": "Function", + "tags": [], "label": "getAll", "description": [], - "source": { - "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 111 - }, "signature": [ "() => ", { @@ -1364,32 +1550,36 @@ "text": "PaletteDefinition" }, "[]" - ] + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 111 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 109 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.RawColorSchema", "type": "Interface", + "tags": [], "label": "RawColorSchema", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.RawColorSchema.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 26 - }, "signature": [ { "pluginId": "charts", @@ -1398,53 +1588,65 @@ "section": "def-public.ColorSchemas", "text": "ColorSchemas" } - ] + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 26 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.RawColorSchema.label", "type": "string", + "tags": [], "label": "label", "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 27 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.RawColorSchema.value", "type": "Array", + "tags": [], "label": "value", "description": [], + "signature": [ + "[number, number[]][]" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 28 }, - "signature": [ - "[number, number[]][]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.SeriesLayer", "type": "Interface", + "tags": [], "label": "SeriesLayer", "description": [ "\nInformation about a series in a chart used to determine its color.\nSeries layers can be nested, this means each series layer can have an ancestor." ], - "tags": [], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.SeriesLayer.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nName of the series (can be used for lookup-based coloring)" @@ -1452,12 +1654,14 @@ "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.SeriesLayer.rankAtDepth", "type": "number", + "tags": [], "label": "rankAtDepth", "description": [ "\nRank of the series compared to siblings with the same ancestor" @@ -1465,12 +1669,14 @@ "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.SeriesLayer.totalSeriesAtDepth", "type": "number", + "tags": [], "label": "totalSeriesAtDepth", "description": [ "\nTotal number of series with the same ancestor" @@ -1478,150 +1684,164 @@ "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 27 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.Style", "type": "Interface", + "tags": [], "label": "Style", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Style.bgFill", "type": "string", + "tags": [], "label": "bgFill", "description": [], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 27 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Style.bgColor", "type": "boolean", + "tags": [], "label": "bgColor", "description": [], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Style.labelColor", "type": "boolean", + "tags": [], "label": "labelColor", "description": [], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 29 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Style.subText", "type": "string", + "tags": [], "label": "subText", "description": [], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.Style.fontSize", "type": "number", + "tags": [], "label": "fontSize", "description": [], "source": { "path": "src/plugins/charts/public/static/components/types.ts", "lineNumber": 31 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/public/static/components/types.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.SystemPaletteArguments", "type": "Interface", + "tags": [], "label": "SystemPaletteArguments", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.SystemPaletteArguments.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 25 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 24 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "charts", "id": "def-public.ColorSchemas", "type": "Enum", - "label": "ColorSchemas", "tags": [], + "label": "ColorSchemas", "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 11 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "charts", "id": "def-public.ColorMode", "type": "Type", - "label": "ColorMode", "tags": [], + "label": "ColorMode", "description": [], + "signature": [ + "\"Background\" | \"Labels\" | \"None\"" + ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 17 }, - "signature": [ - "\"Background\" | \"Labels\" | \"None\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.colorSchemas", "type": "Array", + "tags": [], "label": "colorSchemas", "description": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 174 - }, "signature": [ { "pluginId": "charts", @@ -1632,77 +1852,87 @@ }, "[]" ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 174 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.defaultCountLabel", "type": "string", + "tags": [], "label": "defaultCountLabel", "description": [], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 26 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.LabelRotation", "type": "Type", - "label": "LabelRotation", "tags": [], + "label": "LabelRotation", "description": [], + "signature": [ + "{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number" + ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 24 }, - "signature": [ - "{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.paletteIds", "type": "Array", + "tags": [], "label": "paletteIds", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/charts/common/constants.ts", "lineNumber": 10 }, - "signature": [ - "string[]" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.seedColors", "type": "Array", + "tags": [], "label": "seedColors", "description": [ "\nUsing a random color generator presented awful colors and unpredictable color schemes.\nSo we needed to come up with a color scheme of our own that creates consistent, pleasing color patterns.\nThe order allows us to guarantee that 1st, 2nd, 3rd, etc values always get the same color." ], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/charts/public/static/colors/seed_colors.ts", "lineNumber": 14 }, - "signature": [ - "string[]" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.truncatedColorSchemas", "type": "Array", + "tags": [], "label": "truncatedColorSchemas", "description": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/truncated_color_maps.ts", - "lineNumber": 26 - }, "signature": [ { "pluginId": "charts", @@ -1713,73 +1943,99 @@ }, "[]" ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/truncated_color_maps.ts", + "lineNumber": 26 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.ColorMode", "type": "Object", + "tags": [], "label": "ColorMode", "description": [], + "signature": [ + "Readonly<{ Background: \"Background\"; Labels: \"Labels\"; None: \"None\"; }>" + ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 12 }, - "signature": [ - "Readonly<{ Background: \"Background\"; Labels: \"Labels\"; None: \"None\"; }>" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.LabelRotation", "type": "Object", + "tags": [], "label": "LabelRotation", "description": [], + "signature": [ + "Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>" + ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 19 }, - "signature": [ - "Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.truncatedColorMaps", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "truncatedColorMaps", + "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/truncated_color_maps.ts", "lineNumber": 11 }, + "deprecated": false, + "children": [], "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-public.vislibColorMaps", "type": "Object", "tags": [], + "label": "vislibColorMaps", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Blues", "type": "Object", "tags": [], + "label": "[ColorSchemas.Blues]", + "description": [ + "// Sequential" + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Blues.id", "type": "string", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 38 - }, "signature": [ { "pluginId": "charts", @@ -1789,58 +2045,64 @@ "text": "ColorSchemas" }, ".Blues" - ] + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 38 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Blues.label", "type": "string", + "tags": [], "label": "label", "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 39 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Blues.value", "type": "Array", + "tags": [], "label": "value", "description": [], + "signature": [ + "[number, number[]][]" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 42 }, - "signature": [ - "[number, number[]][]" - ] + "deprecated": false } - ], - "description": [ - "// Sequential" - ], - "label": "[ColorSchemas.Blues]", - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 37 - } + ] }, { + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greens", "type": "Object", "tags": [], + "label": "[ColorSchemas.Greens]", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greens.id", "type": "string", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 56 - }, "signature": [ { "pluginId": "charts", @@ -1850,56 +2112,64 @@ "text": "ColorSchemas" }, ".Greens" - ] + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greens.label", "type": "string", + "tags": [], "label": "label", "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greens.value", "type": "Array", + "tags": [], "label": "value", "description": [], + "signature": [ + "[number, number[]][]" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 60 }, - "signature": [ - "[number, number[]][]" - ] + "deprecated": false } - ], - "description": [], - "label": "[ColorSchemas.Greens]", - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 55 - } + ] }, { + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greys", "type": "Object", "tags": [], + "label": "[ColorSchemas.Greys]", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 73 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greys.id", "type": "string", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 74 - }, "signature": [ { "pluginId": "charts", @@ -1909,56 +2179,64 @@ "text": "ColorSchemas" }, ".Greys" - ] + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 74 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greys.label", "type": "string", + "tags": [], "label": "label", "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 75 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greys.value", "type": "Array", + "tags": [], "label": "value", "description": [], + "signature": [ + "[number, number[]][]" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 78 }, - "signature": [ - "[number, number[]][]" - ] + "deprecated": false } - ], - "description": [], - "label": "[ColorSchemas.Greys]", - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 73 - } + ] }, { + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Reds", "type": "Object", "tags": [], + "label": "[ColorSchemas.Reds]", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 91 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Reds.id", "type": "string", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 92 - }, "signature": [ { "pluginId": "charts", @@ -1968,56 +2246,64 @@ "text": "ColorSchemas" }, ".Reds" - ] + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 92 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Reds.label", "type": "string", + "tags": [], "label": "label", "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 93 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Reds.value", "type": "Array", + "tags": [], "label": "value", "description": [], + "signature": [ + "[number, number[]][]" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 96 }, - "signature": [ - "[number, number[]][]" - ] + "deprecated": false } - ], - "description": [], - "label": "[ColorSchemas.Reds]", - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 91 - } + ] }, { + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed", "type": "Object", "tags": [], + "label": "[ColorSchemas.YellowToRed]", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 109 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.id", "type": "string", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 110 - }, "signature": [ { "pluginId": "charts", @@ -2027,56 +2313,64 @@ "text": "ColorSchemas" }, ".YellowToRed" - ] + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 110 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.label", "type": "string", + "tags": [], "label": "label", "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 111 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.value", "type": "Array", + "tags": [], "label": "value", "description": [], + "signature": [ + "[number, number[]][]" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 114 }, - "signature": [ - "[number, number[]][]" - ] + "deprecated": false } - ], - "description": [], - "label": "[ColorSchemas.YellowToRed]", - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 109 - } + ] }, { + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed", "type": "Object", "tags": [], + "label": "[ColorSchemas.GreenToRed]", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 128 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.id", "type": "string", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 129 - }, "signature": [ { "pluginId": "charts", @@ -2086,66 +2380,63 @@ "text": "ColorSchemas" }, ".GreenToRed" - ] + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 129 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.label", "type": "string", + "tags": [], "label": "label", "description": [], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 130 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.value", "type": "Array", + "tags": [], "label": "value", "description": [], + "signature": [ + "[number, number[]][]" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 133 }, - "signature": [ - "[number, number[]][]" - ] + "deprecated": false } - ], - "description": [], - "label": "[ColorSchemas.GreenToRed]", - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 128 - } + ] } ], - "description": [], - "label": "vislibColorMaps", - "source": { - "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", - "lineNumber": 35 - }, "initialIsOpen": false } ], "start": { + "parentPluginId": "charts", "id": "def-public.ChartsPluginStart", "type": "Type", + "tags": [], "label": "ChartsPluginStart", - "tags": [ - "public" - ], "description": [], + "signature": [ + "ChartsPluginSetup" + ], "source": { "path": "src/plugins/charts/public/plugin.ts", "lineNumber": 31 }, - "signature": [ - "ChartsPluginSetup" - ], + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -2162,9 +2453,12 @@ "classes": [], "functions": [ { + "parentPluginId": "charts", "id": "def-common.palette", "type": "Function", + "tags": [], "label": "palette", + "description": [], "signature": [ "() => ", { @@ -2207,20 +2501,22 @@ "text": "ExecutionContext" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 53 }, + "deprecated": false, + "children": [], + "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-common.systemPalette", "type": "Function", + "tags": [], "label": "systemPalette", + "description": [], "signature": [ "() => ", { @@ -2263,114 +2559,130 @@ "text": "Adapters" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 119 }, + "deprecated": false, + "children": [], + "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "charts", "id": "def-common.CustomPaletteArguments", "type": "Interface", + "tags": [], "label": "CustomPaletteArguments", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-common.CustomPaletteArguments.color", "type": "Array", + "tags": [], "label": "color", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 14 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-common.CustomPaletteArguments.gradient", "type": "boolean", + "tags": [], "label": "gradient", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-common.CustomPaletteArguments.reverse", "type": "CompoundType", + "tags": [], "label": "reverse", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 16 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-common.CustomPaletteState", "type": "Interface", + "tags": [], "label": "CustomPaletteState", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-common.CustomPaletteState.colors", "type": "Array", + "tags": [], "label": "colors", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 20 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-common.CustomPaletteState.gradient", "type": "boolean", + "tags": [], "label": "gradient", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-common.PaletteOutput", "type": "Interface", + "tags": [], "label": "PaletteOutput", + "description": [], "signature": [ { "pluginId": "charts", @@ -2381,126 +2693,141 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-common.PaletteOutput.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"palette\"" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 29 }, - "signature": [ - "\"palette\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-common.PaletteOutput.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-common.PaletteOutput.params", "type": "Uncategorized", + "tags": [], "label": "params", "description": [], + "signature": [ + "T | undefined" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 31 }, - "signature": [ - "T | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "charts", "id": "def-common.SystemPaletteArguments", "type": "Interface", + "tags": [], "label": "SystemPaletteArguments", "description": [], - "tags": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-common.SystemPaletteArguments.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 25 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 24 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "charts", "id": "def-common.COLOR_MAPPING_SETTING", "type": "string", + "tags": [], "label": "COLOR_MAPPING_SETTING", "description": [], + "signature": [ + "\"visualization:colorMapping\"" + ], "source": { "path": "src/plugins/charts/common/index.ts", "lineNumber": 9 }, - "signature": [ - "\"visualization:colorMapping\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-common.defaultCustomColors", "type": "Array", + "tags": [], "label": "defaultCustomColors", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/charts/common/palette.ts", "lineNumber": 33 }, - "signature": [ - "string[]" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "charts", "id": "def-common.paletteIds", "type": "Array", + "tags": [], "label": "paletteIds", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/charts/common/constants.ts", "lineNumber": 10 }, - "signature": [ - "string[]" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/cloud.json b/api_docs/cloud.json index 1ac97f2fac5b3..2b590695b9437 100644 --- a/api_docs/cloud.json +++ b/api_docs/cloud.json @@ -5,101 +5,115 @@ "functions": [], "interfaces": [ { + "parentPluginId": "cloud", "id": "def-public.CloudConfigType", "type": "Interface", + "tags": [], "label": "CloudConfigType", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudConfigType.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudConfigType.cname", "type": "string", + "tags": [], "label": "cname", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudConfigType.base_url", "type": "string", + "tags": [], "label": "base_url", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudConfigType.profile_url", "type": "string", + "tags": [], "label": "profile_url", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", "lineNumber": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudConfigType.deployment_url", "type": "string", + "tags": [], "label": "deployment_url", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", "lineNumber": 22 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudConfigType.organization_url", "type": "string", + "tags": [], "label": "organization_url", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", "lineNumber": 23 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 17 - }, "initialIsOpen": false } ], @@ -107,112 +121,128 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "cloud", "id": "def-public.CloudSetup", "type": "Interface", + "tags": [], "label": "CloudSetup", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudSetup.cloudId", "type": "string", + "tags": [], "label": "cloudId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 35 + "lineNumber": 36 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudSetup.cname", "type": "string", + "tags": [], "label": "cname", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 36 + "lineNumber": 37 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudSetup.baseUrl", "type": "string", + "tags": [], "label": "baseUrl", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 37 + "lineNumber": 38 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudSetup.deploymentUrl", "type": "string", + "tags": [], "label": "deploymentUrl", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 38 + "lineNumber": 39 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudSetup.profileUrl", "type": "string", + "tags": [], "label": "profileUrl", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 39 + "lineNumber": 40 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudSetup.organizationUrl", "type": "string", + "tags": [], "label": "organizationUrl", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 40 + "lineNumber": 41 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-public.CloudSetup.isCloudEnabled", "type": "boolean", + "tags": [], "label": "isCloudEnabled", "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 41 - } + "lineNumber": 42 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 34 - }, "lifecycle": "setup", "initialIsOpen": true } @@ -225,56 +255,80 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "cloud", "id": "def-server.CloudSetup", "type": "Interface", + "tags": [], "label": "CloudSetup", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cloud/server/plugin.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cloud", "id": "def-server.CloudSetup.cloudId", "type": "string", + "tags": [], "label": "cloudId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cloud/server/plugin.ts", - "lineNumber": 19 + "lineNumber": 20 }, + "deprecated": false + }, + { + "parentPluginId": "cloud", + "id": "def-server.CloudSetup.deploymentId", + "type": "string", + "tags": [], + "label": "deploymentId", + "description": [], "signature": [ "string | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/cloud/server/plugin.ts", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-server.CloudSetup.isCloudEnabled", "type": "boolean", + "tags": [], "label": "isCloudEnabled", "description": [], "source": { "path": "x-pack/plugins/cloud/server/plugin.ts", - "lineNumber": 20 - } + "lineNumber": 22 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "cloud", "id": "def-server.CloudSetup.apm", "type": "Object", + "tags": [], "label": "apm", "description": [], + "signature": [ + "{ url?: string | undefined; secretToken?: string | undefined; }" + ], "source": { "path": "x-pack/plugins/cloud/server/plugin.ts", - "lineNumber": 21 + "lineNumber": 23 }, - "signature": [ - "{ url?: string | undefined; secretToken?: string | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cloud/server/plugin.ts", - "lineNumber": 18 - }, "lifecycle": "setup", "initialIsOpen": true } diff --git a/api_docs/console.json b/api_docs/console.json index 4ebbceac866b1..cc47365cf552e 100644 --- a/api_docs/console.json +++ b/api_docs/console.json @@ -16,38 +16,38 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "console", "id": "def-server.ConsoleSetup", "type": "Type", + "tags": [], "label": "ConsoleSetup", - "tags": [ - "public" - ], "description": [], + "signature": [ + "{ addExtensionSpecFilePath: (path: string) => void; }" + ], "source": { "path": "src/plugins/console/server/types.ts", "lineNumber": 13 }, - "signature": [ - "{ addExtensionSpecFilePath: (path: string) => void; }" - ], + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "console", "id": "def-server.ConsoleStart", "type": "Type", + "tags": [], "label": "ConsoleStart", - "tags": [ - "public" - ], "description": [], + "signature": [ + "{ addProcessorDefinition: (processor: unknown) => void; }" + ], "source": { "path": "src/plugins/console/server/types.ts", "lineNumber": 18 }, - "signature": [ - "{ addProcessorDefinition: (processor: unknown) => void; }" - ], + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } diff --git a/api_docs/core.json b/api_docs/core.json index 9695aaebdd313..b32409a29ca52 100644 --- a/api_docs/core.json +++ b/api_docs/core.json @@ -3,11 +3,10 @@ "client": { "classes": [ { + "parentPluginId": "core", "id": "def-public.ToastsApi", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "ToastsApi", "description": [ "\nMethods for adding and removing global toast messages." @@ -30,33 +29,48 @@ }, ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 94 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ToastsApi.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 102 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ToastsApi.Unnamed.$1.deps", "type": "Object", - "label": "deps", "tags": [], + "label": "deps", "description": [], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 102 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ToastsApi.Unnamed.$1.deps.uiSettings", "type": "Object", + "tags": [], "label": "uiSettings", "description": [], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 102 - }, "signature": [ { "pluginId": "core", @@ -65,26 +79,27 @@ "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" } - ] + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 102 + }, + "deprecated": false } - ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 102 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 102 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.get$", "type": "Function", + "tags": [], "label": "get$", + "description": [ + "Observable of the toast messages to show to the user." + ], "signature": [ "() => ", "Observable", @@ -98,21 +113,23 @@ }, "[]>" ], - "description": [ - "Observable of the toast messages to show to the user." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 113 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.add", "type": "Function", + "tags": [], "label": "add", + "description": [ + "\nAdds a new toast to current array of toast.\n" + ], "signature": [ "(toastOrTitle: ", { @@ -131,15 +148,21 @@ "text": "Toast" } ], - "description": [ - "\nAdds a new toast to current array of toast.\n" - ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 123 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ToastsApi.add.$1", "type": "CompoundType", + "tags": [], "label": "toastOrTitle", - "isRequired": true, + "description": [ + "- a {@link ToastInput}" + ], "signature": [ { "pluginId": "core", @@ -149,28 +172,27 @@ "text": "ToastInput" } ], - "description": [ - "- a {@link ToastInput}" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 123 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "a {@link Toast}" - ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 123 - } + ] }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.remove", "type": "Function", + "tags": [], "label": "remove", + "description": [ + "\nRemoves a toast from the current array of toasts if present." + ], "signature": [ "(toastOrId: string | ", { @@ -182,15 +204,21 @@ }, ") => void" ], - "description": [ - "\nRemoves a toast from the current array of toasts if present." - ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 139 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ToastsApi.remove.$1", "type": "CompoundType", + "tags": [], "label": "toastOrId", - "isRequired": true, + "description": [ + "- a {@link Toast} returned by {@link ToastsApi.add} or its id" + ], "signature": [ "string | ", { @@ -201,26 +229,25 @@ "text": "Toast" } ], - "description": [ - "- a {@link Toast} returned by {@link ToastsApi.add} or its id" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 139 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 139 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.addInfo", "type": "Function", + "tags": [], "label": "addInfo", + "description": [ + "\nAdds a new toast pre-configured with the info color and info icon.\n" + ], "signature": [ "(toastOrTitle: ", { @@ -247,15 +274,21 @@ "text": "Toast" } ], - "description": [ - "\nAdds a new toast pre-configured with the info color and info icon.\n" - ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 155 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ToastsApi.addInfo.$1", "type": "CompoundType", + "tags": [], "label": "toastOrTitle", - "isRequired": true, + "description": [ + "- a {@link ToastInput}" + ], "signature": [ { "pluginId": "core", @@ -265,19 +298,22 @@ "text": "ToastInput" } ], - "description": [ - "- a {@link ToastInput}" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 155 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.addInfo.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [ + "- a {@link ToastOptions}" + ], "signature": [ { "pluginId": "core", @@ -288,28 +324,27 @@ }, " | undefined" ], - "description": [ - "- a {@link ToastOptions}" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 155 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [ "a {@link Toast}" - ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 155 - } + ] }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.addSuccess", "type": "Function", + "tags": [], "label": "addSuccess", + "description": [ + "\nAdds a new toast pre-configured with the success color and check icon.\n" + ], "signature": [ "(toastOrTitle: ", { @@ -336,15 +371,21 @@ "text": "Toast" } ], - "description": [ - "\nAdds a new toast pre-configured with the success color and check icon.\n" - ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 171 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ToastsApi.addSuccess.$1", "type": "CompoundType", + "tags": [], "label": "toastOrTitle", - "isRequired": true, + "description": [ + "- a {@link ToastInput}" + ], "signature": [ { "pluginId": "core", @@ -354,19 +395,22 @@ "text": "ToastInput" } ], - "description": [ - "- a {@link ToastInput}" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 171 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.addSuccess.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [ + "- a {@link ToastOptions}" + ], "signature": [ { "pluginId": "core", @@ -377,28 +421,27 @@ }, " | undefined" ], - "description": [ - "- a {@link ToastOptions}" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 171 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [ "a {@link Toast}" - ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 171 - } + ] }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.addWarning", "type": "Function", + "tags": [], "label": "addWarning", + "description": [ + "\nAdds a new toast pre-configured with the warning color and help icon.\n" + ], "signature": [ "(toastOrTitle: ", { @@ -425,15 +468,21 @@ "text": "Toast" } ], - "description": [ - "\nAdds a new toast pre-configured with the warning color and help icon.\n" - ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 187 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ToastsApi.addWarning.$1", "type": "CompoundType", + "tags": [], "label": "toastOrTitle", - "isRequired": true, + "description": [ + "- a {@link ToastInput}" + ], "signature": [ { "pluginId": "core", @@ -443,19 +492,22 @@ "text": "ToastInput" } ], - "description": [ - "- a {@link ToastInput}" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 187 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.addWarning.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [ + "- a {@link ToastOptions}" + ], "signature": [ { "pluginId": "core", @@ -466,28 +518,27 @@ }, " | undefined" ], - "description": [ - "- a {@link ToastOptions}" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 187 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [ "a {@link Toast}" - ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 187 - } + ] }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.addDanger", "type": "Function", + "tags": [], "label": "addDanger", + "description": [ + "\nAdds a new toast pre-configured with the danger color and alert icon.\n" + ], "signature": [ "(toastOrTitle: ", { @@ -514,15 +565,21 @@ "text": "Toast" } ], - "description": [ - "\nAdds a new toast pre-configured with the danger color and alert icon.\n" - ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 204 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ToastsApi.addDanger.$1", "type": "CompoundType", + "tags": [], "label": "toastOrTitle", - "isRequired": true, + "description": [ + "- a {@link ToastInput}" + ], "signature": [ { "pluginId": "core", @@ -532,19 +589,22 @@ "text": "ToastInput" } ], - "description": [ - "- a {@link ToastInput}" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 204 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.addDanger.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [ + "- a {@link ToastOptions}" + ], "signature": [ { "pluginId": "core", @@ -555,28 +615,27 @@ }, " | undefined" ], - "description": [ - "- a {@link ToastOptions}" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 204 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [ "a {@link Toast}" - ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 204 - } + ] }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.addError", "type": "Function", + "tags": [], "label": "addError", + "description": [ + "\nAdds a new toast that displays an exception message with a button to open the full stacktrace in a modal.\n" + ], "signature": [ "(error: Error, options: ", { @@ -595,31 +654,40 @@ "text": "Toast" } ], - "description": [ - "\nAdds a new toast that displays an exception message with a button to open the full stacktrace in a modal.\n" - ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 221 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ToastsApi.addError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, - "signature": [ - "Error" - ], "description": [ "- an `Error` instance." ], - "source": { + "signature": [ + "Error" + ], + "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 221 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ToastsApi.addError.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [ + "- {@link ErrorToastOptions}" + ], "signature": [ { "pluginId": "core", @@ -629,49 +697,44 @@ "text": "ErrorToastOptions" } ], - "description": [ - "- {@link ErrorToastOptions}" - ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 221 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "a {@link Toast}" - ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 221 - } + ] } ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 94 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "core", "id": "def-public.AppCategory", "type": "Interface", + "tags": [], "label": "AppCategory", "description": [ "\n\nA category definition for nav links to know where to sort them in the left hand nav" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/app_category.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppCategory.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nUnique identifier for the categories" @@ -679,12 +742,14 @@ "source": { "path": "src/core/types/app_category.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppCategory.label", "type": "string", + "tags": [], "label": "label", "description": [ "\nLabel used for category name.\nAlso used as aria-label if one isn't set." @@ -692,67 +757,77 @@ "source": { "path": "src/core/types/app_category.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppCategory.ariaLabel", "type": "string", + "tags": [], "label": "ariaLabel", "description": [ "\nIf the visual label isn't appropriate for screen readers,\ncan override it here" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/types/app_category.ts", "lineNumber": 31 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppCategory.order", "type": "number", + "tags": [], "label": "order", "description": [ "\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)" ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/types/app_category.ts", "lineNumber": 38 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppCategory.euiIconType", "type": "string", + "tags": [], "label": "euiIconType", "description": [ "\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/types/app_category.ts", "lineNumber": 45 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AsyncPlugin", "type": "Interface", + "tags": [ + "deprecated" + ], "label": "AsyncPlugin", + "description": [ + "\nA plugin with asynchronous lifecycle methods.\n" + ], "signature": [ { "pluginId": "core", @@ -763,18 +838,20 @@ }, "" ], - "description": [ - "\nA plugin with asynchronous lifecycle methods.\n" - ], - "tags": [ - "deprecated", - "public" - ], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 39 + }, + "deprecated": true, + "references": [], "children": [ { + "parentPluginId": "core", "id": "def-public.AsyncPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -786,13 +863,19 @@ }, ", plugins: TPluginsSetup) => TSetup | Promise" ], - "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.AsyncPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -803,38 +886,40 @@ }, "" ], - "description": [], "source": { "path": "src/core/public/plugins/plugin.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.AsyncPlugin.setup.$2", "type": "Uncategorized", + "tags": [], "label": "plugins", - "isRequired": true, + "description": [], "signature": [ "TPluginsSetup" ], - "description": [], "source": { "path": "src/core/public/plugins/plugin.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/plugins/plugin.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.AsyncPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -846,13 +931,19 @@ }, ", plugins: TPluginsStart) => TStart | Promise" ], - "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.AsyncPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -862,143 +953,153 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/core/public/plugins/plugin.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.AsyncPlugin.start.$2", "type": "Uncategorized", + "tags": [], "label": "plugins", - "isRequired": true, + "description": [], "signature": [ "TPluginsStart" ], - "description": [], "source": { "path": "src/core/public/plugins/plugin.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/plugins/plugin.ts", - "lineNumber": 46 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.AsyncPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "(() => void) | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/plugins/plugin.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/public/plugins/plugin.ts", - "lineNumber": 39 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.Capabilities", "type": "Interface", + "tags": [], "label": "Capabilities", "description": [ "\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.Capabilities.navLinks", "type": "Object", + "tags": [], "label": "navLinks", "description": [ "Navigation link capabilities." ], + "signature": [ + "Record" + ], "source": { "path": "src/core/types/capabilities.ts", "lineNumber": 18 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.Capabilities.management", "type": "Object", + "tags": [], "label": "management", "description": [ "Management section capabilities." ], + "signature": [ + "{ [sectionId: string]: Record; }" + ], "source": { "path": "src/core/types/capabilities.ts", "lineNumber": 21 }, - "signature": [ - "{ [sectionId: string]: Record; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.Capabilities.catalogue", "type": "Object", + "tags": [], "label": "catalogue", "description": [ "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." ], + "signature": [ + "Record" + ], "source": { "path": "src/core/types/capabilities.ts", "lineNumber": 26 }, - "signature": [ - "Record" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.Capabilities.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [ "Custom capabilities, registered by plugins." ], + "signature": [ + "any" + ], "source": { "path": "src/core/types/capabilities.ts", "lineNumber": 29 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/capabilities.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.CoreSetup", "type": "Interface", + "tags": [], "label": "CoreSetup", + "description": [ + "\nCore services exposed to the `Plugin` setup lifecycle\n" + ], "signature": [ { "pluginId": "core", @@ -1009,25 +1110,21 @@ }, "" ], - "description": [ - "\nCore services exposed to the `Plugin` setup lifecycle\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 213 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreSetup.application", "type": "Object", + "tags": [], "label": "application", "description": [ "{@link ApplicationSetup}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 210 - }, "signature": [ { "pluginId": "core", @@ -1036,20 +1133,22 @@ "section": "def-public.ApplicationSetup", "text": "ApplicationSetup" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 215 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreSetup.fatalErrors", "type": "Object", + "tags": [], "label": "fatalErrors", "description": [ "{@link FatalErrorsSetup}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 212 - }, "signature": [ { "pluginId": "core", @@ -1058,20 +1157,22 @@ "section": "def-public.FatalErrorsSetup", "text": "FatalErrorsSetup" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 217 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreSetup.http", "type": "Object", + "tags": [], "label": "http", "description": [ "{@link HttpSetup}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 214 - }, "signature": [ { "pluginId": "core", @@ -1080,20 +1181,22 @@ "section": "def-public.HttpSetup", "text": "HttpSetup" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 219 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreSetup.notifications", "type": "Object", + "tags": [], "label": "notifications", "description": [ "{@link NotificationsSetup}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 216 - }, "signature": [ { "pluginId": "core", @@ -1102,20 +1205,22 @@ "section": "def-public.NotificationsSetup", "text": "NotificationsSetup" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 221 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreSetup.uiSettings", "type": "Object", + "tags": [], "label": "uiSettings", "description": [ "{@link IUiSettingsClient}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 218 - }, "signature": [ { "pluginId": "core", @@ -1124,38 +1229,43 @@ "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 223 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-public.CoreSetup.injectedMetadata", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-public.CoreSetup.injectedMetadata", - "type": "Object", "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." ], + "signature": [ + "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" + ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 225 + "lineNumber": 230 }, - "signature": [ - "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" - ] + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreSetup.getStartServices", "type": "Function", + "tags": [], "label": "getStartServices", "description": [ "{@link StartServicesAccessor}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 229 - }, "signature": [ { "pluginId": "core", @@ -1165,38 +1275,40 @@ "text": "StartServicesAccessor" }, "" - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 234 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 208 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.CoreStart", "type": "Interface", + "tags": [], "label": "CoreStart", "description": [ "\nCore services exposed to the `Plugin` start lifecycle\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 258 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.application", "type": "Object", + "tags": [], "label": "application", "description": [ "{@link ApplicationStart}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 255 - }, "signature": [ { "pluginId": "core", @@ -1205,20 +1317,22 @@ "section": "def-public.ApplicationStart", "text": "ApplicationStart" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 260 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.chrome", "type": "Object", + "tags": [], "label": "chrome", "description": [ "{@link ChromeStart}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 257 - }, "signature": [ { "pluginId": "core", @@ -1227,20 +1341,22 @@ "section": "def-public.ChromeStart", "text": "ChromeStart" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 262 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.docLinks", "type": "Object", + "tags": [], "label": "docLinks", "description": [ "{@link DocLinksStart}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 259 - }, "signature": [ { "pluginId": "core", @@ -1249,20 +1365,22 @@ "section": "def-public.DocLinksStart", "text": "DocLinksStart" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 264 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.http", "type": "Object", + "tags": [], "label": "http", "description": [ "{@link HttpStart}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 261 - }, "signature": [ { "pluginId": "core", @@ -1271,20 +1389,22 @@ "section": "def-public.HttpSetup", "text": "HttpSetup" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 266 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.savedObjects", "type": "Object", + "tags": [], "label": "savedObjects", "description": [ "{@link SavedObjectsStart}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 263 - }, "signature": [ { "pluginId": "core", @@ -1293,20 +1413,22 @@ "section": "def-public.SavedObjectsStart", "text": "SavedObjectsStart" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 268 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.i18n", "type": "Object", + "tags": [], "label": "i18n", "description": [ "{@link I18nStart}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 265 - }, "signature": [ { "pluginId": "core", @@ -1315,20 +1437,22 @@ "section": "def-public.I18nStart", "text": "I18nStart" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 270 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.notifications", "type": "Object", + "tags": [], "label": "notifications", "description": [ "{@link NotificationsStart}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 267 - }, "signature": [ { "pluginId": "core", @@ -1337,20 +1461,22 @@ "section": "def-public.NotificationsStart", "text": "NotificationsStart" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 272 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.overlays", "type": "Object", + "tags": [], "label": "overlays", "description": [ "{@link OverlayStart}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 269 - }, "signature": [ { "pluginId": "core", @@ -1359,20 +1485,22 @@ "section": "def-public.OverlayStart", "text": "OverlayStart" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 274 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.uiSettings", "type": "Object", + "tags": [], "label": "uiSettings", "description": [ "{@link IUiSettingsClient}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 271 - }, "signature": [ { "pluginId": "core", @@ -1381,20 +1509,22 @@ "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 276 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.fatalErrors", "type": "Object", + "tags": [], "label": "fatalErrors", "description": [ "{@link FatalErrorsStart}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 273 - }, "signature": [ { "pluginId": "core", @@ -1403,20 +1533,22 @@ "section": "def-public.FatalErrorsSetup", "text": "FatalErrorsSetup" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 278 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.CoreStart.deprecations", "type": "Object", + "tags": [], "label": "deprecations", "description": [ "{@link DeprecationsServiceStart}" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 275 - }, "signature": [ { "pluginId": "core", @@ -1425,110 +1557,129 @@ "section": "def-public.DeprecationsServiceStart", "text": "DeprecationsServiceStart" } - ] + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 280 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-public.CoreStart.injectedMetadata", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-public.CoreStart.injectedMetadata", - "type": "Object", "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." ], + "signature": [ + "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" + ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 282 + "lineNumber": 287 }, - "signature": [ - "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" + "deprecated": true, + "references": [ + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/public/legacy_shims.ts", + "lineNumber": 81 + } + } ] } ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 253 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.DeprecationsServiceStart", "type": "Interface", + "tags": [], "label": "DeprecationsServiceStart", "description": [ "\nDeprecationsService provides methods to fetch domain deprecation details from\nthe Kibana server.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.DeprecationsServiceStart.getAllDeprecations", "type": "Function", + "tags": [], "label": "getAllDeprecations", "description": [ "\nGrabs deprecations details for all domains." ], - "source": { - "path": "src/core/public/deprecations/deprecations_service.ts", - "lineNumber": 24 - }, "signature": [ "() => Promise<", "DomainDeprecationDetails", "[]>" - ] + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 24 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.DeprecationsServiceStart.getDeprecations", "type": "Function", + "tags": [], "label": "getDeprecations", "description": [ "\nGrabs deprecations for a specific domain.\n" ], - "source": { - "path": "src/core/public/deprecations/deprecations_service.ts", - "lineNumber": 30 - }, "signature": [ "(domainId: string) => Promise<", "DomainDeprecationDetails", "[]>" - ] + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 30 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.DeprecationsServiceStart.isDeprecationResolvable", "type": "Function", + "tags": [], "label": "isDeprecationResolvable", "description": [ "\nReturns a boolean if the provided deprecation can be automatically resolvable.\n" ], - "source": { - "path": "src/core/public/deprecations/deprecations_service.ts", - "lineNumber": 36 - }, "signature": [ "(details: ", "DomainDeprecationDetails", ") => boolean" - ] + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 36 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.DeprecationsServiceStart.resolveDeprecation", "type": "Function", + "tags": [], "label": "resolveDeprecation", "description": [ "\nCalls the correctiveActions.api to automatically resolve the depprecation.\n" ], - "source": { - "path": "src/core/public/deprecations/deprecations_service.ts", - "lineNumber": 42 - }, "signature": [ "(details: ", "DomainDeprecationDetails", @@ -1541,126 +1692,184 @@ "text": "ResolveDeprecationResponse" }, ">" - ] + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 42 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/deprecations/deprecations_service.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.DocLinksStart", "type": "Interface", + "tags": [], "label": "DocLinksStart", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/doc_links/doc_links_service.ts", + "lineNumber": 407 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.DocLinksStart.DOC_LINK_VERSION", "type": "string", + "tags": [], "label": "DOC_LINK_VERSION", "description": [], "source": { "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 349 - } + "lineNumber": 408 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.DocLinksStart.ELASTIC_WEBSITE_URL", "type": "string", + "tags": [], "label": "ELASTIC_WEBSITE_URL", "description": [], "source": { "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 350 - } + "lineNumber": 409 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.DocLinksStart.links", "type": "Object", + "tags": [], "label": "links", "description": [], + "signature": [ + "{ readonly canvas: { readonly guide: string; }; readonly dashboard: { readonly guide: string; readonly drilldowns: string; readonly drilldownsTriggerPicker: string; readonly urlDrilldownTemplateSyntax: string; readonly urlDrilldownVariables: string; }; readonly discover: Record; readonly filebeat: { readonly base: string; readonly installation: string; readonly configuration: string; readonly elasticsearchOutput: string; readonly elasticsearchModule: string; readonly startup: string; readonly exportedFields: string; }; readonly auditbeat: { readonly base: string; }; readonly metricbeat: { readonly base: string; readonly configure: string; readonly httpEndpoint: string; readonly install: string; readonly start: string; }; readonly enterpriseSearch: { readonly base: string; readonly appSearchBase: string; readonly workplaceSearchBase: string; }; readonly heartbeat: { readonly base: string; }; readonly logstash: { readonly base: string; }; readonly functionbeat: { readonly base: string; }; readonly winlogbeat: { readonly base: string; }; readonly aggs: { readonly composite: string; readonly composite_missing_bucket: string; readonly date_histogram: string; readonly date_range: string; readonly date_format_pattern: string; readonly filter: string; readonly filters: string; readonly geohash_grid: string; readonly histogram: string; readonly ip_range: string; readonly range: string; readonly significant_terms: string; readonly terms: string; readonly avg: string; readonly avg_bucket: string; readonly max_bucket: string; readonly min_bucket: string; readonly sum_bucket: string; readonly cardinality: string; readonly count: string; readonly cumulative_sum: string; readonly derivative: string; readonly geo_bounds: string; readonly geo_centroid: string; readonly max: string; readonly median: string; readonly min: string; readonly moving_avg: string; readonly percentile_ranks: string; readonly serial_diff: string; readonly std_dev: string; readonly sum: string; readonly top_hits: string; }; readonly runtimeFields: { readonly overview: string; readonly mapping: string; }; readonly scriptedFields: { readonly scriptFields: string; readonly scriptAggs: string; readonly painless: string; readonly painlessApi: string; readonly painlessLangSpec: string; readonly painlessSyntax: string; readonly painlessWalkthrough: string; readonly luceneExpressions: string; }; readonly search: { readonly sessions: string; }; readonly indexPatterns: { readonly introduction: string; readonly fieldFormattersNumber: string; readonly fieldFormattersString: string; }; readonly addData: string; readonly kibana: string; readonly upgradeAssistant: string; readonly elasticsearch: Record; readonly siem: { readonly guide: string; readonly gettingStarted: string; }; readonly query: { readonly eql: string; readonly kueryQuerySyntax: string; readonly luceneQuerySyntax: string; readonly percolate: string; readonly queryDsl: string; }; readonly date: { readonly dateMath: string; readonly dateMathIndexNames: string; }; readonly management: Record; readonly ml: Record; readonly transforms: Record; readonly visualize: Record; readonly apis: Readonly<{ bulkIndexAlias: string; byteSizeUnits: string; createAutoFollowPattern: string; createFollower: string; createIndex: string; createSnapshotLifecyclePolicy: string; createRoleMapping: string; createRoleMappingTemplates: string; createApiKey: string; createPipeline: string; createTransformRequest: string; cronExpressions: string; executeWatchActionModes: string; indexExists: string; openIndex: string; putComponentTemplate: string; painlessExecute: string; painlessExecuteAPIContexts: string; putComponentTemplateMetadata: string; putSnapshotLifecyclePolicy: string; putIndexTemplateV1: string; putWatch: string; simulatePipeline: string; timeUnits: string; updateTransform: string; }>; readonly observability: Record; readonly alerting: Record; readonly maps: Record; readonly monitoring: Record; readonly security: Readonly<{ apiKeyServiceSettings: string; clusterPrivileges: string; elasticsearchSettings: string; elasticsearchEnableSecurity: string; indicesPrivileges: string; kibanaTLS: string; kibanaPrivileges: string; mappingRoles: string; mappingRolesFieldRules: string; runAsPrivilege: string; }>; readonly watcher: Record; readonly ccs: Record; readonly plugins: Record; readonly snapshotRestore: Record; readonly ingest: Record; }" + ], "source": { "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 351 + "lineNumber": 410 }, - "signature": [ - "{ readonly dashboard: { readonly guide: string; readonly drilldowns: string; readonly drilldownsTriggerPicker: string; readonly urlDrilldownTemplateSyntax: string; readonly urlDrilldownVariables: string; }; readonly discover: Record; readonly filebeat: { readonly base: string; readonly installation: string; readonly configuration: string; readonly elasticsearchOutput: string; readonly elasticsearchModule: string; readonly startup: string; readonly exportedFields: string; }; readonly auditbeat: { readonly base: string; }; readonly metricbeat: { readonly base: string; readonly configure: string; readonly httpEndpoint: string; readonly install: string; readonly start: string; }; readonly enterpriseSearch: { readonly base: string; readonly appSearchBase: string; readonly workplaceSearchBase: string; }; readonly heartbeat: { readonly base: string; }; readonly logstash: { readonly base: string; }; readonly functionbeat: { readonly base: string; }; readonly winlogbeat: { readonly base: string; }; readonly aggs: { readonly composite: string; readonly composite_missing_bucket: string; readonly date_histogram: string; readonly date_range: string; readonly date_format_pattern: string; readonly filter: string; readonly filters: string; readonly geohash_grid: string; readonly histogram: string; readonly ip_range: string; readonly range: string; readonly significant_terms: string; readonly terms: string; readonly avg: string; readonly avg_bucket: string; readonly max_bucket: string; readonly min_bucket: string; readonly sum_bucket: string; readonly cardinality: string; readonly count: string; readonly cumulative_sum: string; readonly derivative: string; readonly geo_bounds: string; readonly geo_centroid: string; readonly max: string; readonly median: string; readonly min: string; readonly moving_avg: string; readonly percentile_ranks: string; readonly serial_diff: string; readonly std_dev: string; readonly sum: string; readonly top_hits: string; }; readonly runtimeFields: { readonly mapping: string; }; readonly scriptedFields: { readonly scriptFields: string; readonly scriptAggs: string; readonly painless: string; readonly painlessApi: string; readonly painlessLangSpec: string; readonly painlessSyntax: string; readonly painlessWalkthrough: string; readonly luceneExpressions: string; }; readonly indexPatterns: { readonly introduction: string; readonly fieldFormattersNumber: string; readonly fieldFormattersString: string; }; readonly addData: string; readonly kibana: string; readonly elasticsearch: Record; readonly siem: { readonly guide: string; readonly gettingStarted: string; }; readonly query: { readonly eql: string; readonly luceneQuerySyntax: string; readonly queryDsl: string; readonly kueryQuerySyntax: string; }; readonly date: { readonly dateMath: string; readonly dateMathIndexNames: string; }; readonly management: Record; readonly ml: Record; readonly transforms: Record; readonly visualize: Record; readonly apis: Readonly<{ createIndex: string; createSnapshotLifecyclePolicy: string; createRoleMapping: string; createRoleMappingTemplates: string; createApiKey: string; createPipeline: string; createTransformRequest: string; cronExpressions: string; executeWatchActionModes: string; indexExists: string; openIndex: string; putComponentTemplate: string; painlessExecute: string; painlessExecuteAPIContexts: string; putComponentTemplateMetadata: string; putSnapshotLifecyclePolicy: string; putWatch: string; simulatePipeline: string; updateTransform: string; }>; readonly observability: Record; readonly alerting: Record; readonly maps: Record; readonly monitoring: Record; readonly security: Readonly<{ apiKeyServiceSettings: string; clusterPrivileges: string; elasticsearchSettings: string; elasticsearchEnableSecurity: string; indicesPrivileges: string; kibanaTLS: string; kibanaPrivileges: string; mappingRoles: string; mappingRolesFieldRules: string; runAsPrivilege: string; }>; readonly watcher: Record; readonly ccs: Record; readonly plugins: Record; readonly snapshotRestore: Record; readonly ingest: Record; }" - ] + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.DomainDeprecationDetails", + "type": "Interface", + "tags": [], + "label": "DomainDeprecationDetails", + "description": [], + "signature": [ + "DomainDeprecationDetails", + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsDetails", + "text": "DeprecationsDetails" } ], "source": { - "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 348 + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 14 }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.DomainDeprecationDetails.domainId", + "type": "string", + "tags": [], + "label": "domainId", + "description": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 15 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.EnvironmentMode", "type": "Interface", + "tags": [], "label": "EnvironmentMode", + "description": [], "signature": [ "EnvironmentMode" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.EnvironmentMode.name", "type": "CompoundType", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"production\" | \"development\"" + ], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 15 }, - "signature": [ - "\"production\" | \"development\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.EnvironmentMode.dev", "type": "boolean", + "tags": [], "label": "dev", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.EnvironmentMode.prod", "type": "boolean", + "tags": [], "label": "prod", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 17 - } + }, + "deprecated": false } ], - "source": { - "path": "node_modules/@kbn/config/target/types.d.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ErrorToastOptions", "type": "Interface", + "tags": [], "label": "ErrorToastOptions", + "description": [ + "\nOptions available for {@link IToasts} error APIs." + ], "signature": [ { "pluginId": "core", @@ -1678,17 +1887,17 @@ "text": "ToastOptions" } ], - "description": [ - "\nOptions available for {@link IToasts} error APIs." - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 58 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ErrorToastOptions.title", "type": "string", + "tags": [], "label": "title", "description": [ "\nThe title of the toast and the dialog when expanding the message." @@ -1696,113 +1905,119 @@ "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 62 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ErrorToastOptions.toastMessage", "type": "string", + "tags": [], "label": "toastMessage", "description": [ "\nThe message to be shown in the toast. If this is not specified the error's\nmessage will be shown in the toast instead. Overwriting that message can\nbe used to provide more user-friendly toasts. If you specify this, the error\nmessage will still be shown in the detailed error modal." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 69 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 58 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.FatalErrorInfo", "type": "Interface", + "tags": [], "label": "FatalErrorInfo", "description": [ "\nRepresents the `message` and `stack` of a fatal Error\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/fatal_errors/get_error_info.ts", + "lineNumber": 72 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.FatalErrorInfo.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/core/public/fatal_errors/get_error_info.ts", "lineNumber": 73 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.FatalErrorInfo.stack", "type": "string", + "tags": [], "label": "stack", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/fatal_errors/get_error_info.ts", "lineNumber": 74 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/fatal_errors/get_error_info.ts", - "lineNumber": 72 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.FatalErrorsSetup", "type": "Interface", + "tags": [], "label": "FatalErrorsSetup", "description": [ "\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.FatalErrorsSetup.add", "type": "Function", + "tags": [], "label": "add", "description": [ "\nAdd a new fatal error. This will stop the Kibana Public Core and display\na fatal error screen with details about the Kibana build and the error.\n" ], + "signature": [ + "(error: string | Error, source?: string | undefined) => never" + ], "source": { "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", "lineNumber": 38 }, - "signature": [ - "(error: string | Error, source?: string | undefined) => never" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.FatalErrorsSetup.get$", "type": "Function", + "tags": [], "label": "get$", "description": [ "\nAn Observable that will emit whenever a fatal error is added with `add()`" ], - "source": { - "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", - "lineNumber": 43 - }, "signature": [ "() => ", "Observable", @@ -1815,64 +2030,72 @@ "text": "FatalErrorInfo" }, ">" - ] + ], + "source": { + "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", + "lineNumber": 43 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.I18nStart", "type": "Interface", + "tags": [], "label": "I18nStart", "description": [ "\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/i18n/i18n_service.tsx", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.I18nStart.Context", "type": "Function", + "tags": [], "label": "Context", "description": [ "\nReact Context provider required as the topmost component for any i18n-compatible React tree." ], + "signature": [ + "({ children }: { children: React.ReactNode; }) => JSX.Element" + ], "source": { "path": "src/core/public/i18n/i18n_service.tsx", "lineNumber": 65 }, - "signature": [ - "({ children }: { children: React.ReactNode; }) => JSX.Element" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/i18n/i18n_service.tsx", - "lineNumber": 61 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.IExternalUrlPolicy", "type": "Interface", + "tags": [], "label": "IExternalUrlPolicy", "description": [ "\nA policy describing whether access to an external destination is allowed." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.IExternalUrlPolicy.allow", "type": "boolean", + "tags": [], "label": "allow", "description": [ "\nIndicates if this policy allows or denies access to the described destination." @@ -1880,336 +2103,328 @@ "source": { "path": "src/core/server/external_url/external_url_config.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IExternalUrlPolicy.host", "type": "string", + "tags": [], "label": "host", "description": [ "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/external_url/external_url_config.ts", "lineNumber": 46 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IExternalUrlPolicy.protocol", "type": "string", + "tags": [], "label": "protocol", "description": [ "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/external_url/external_url_config.ts", "lineNumber": 59 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/external_url/external_url_config.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ImageValidation", "type": "Interface", + "tags": [], "label": "ImageValidation", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 131 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ImageValidation.maxSize", "type": "Object", + "tags": [], "label": "maxSize", "description": [], + "signature": [ + "{ length: number; description: string; }" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 132 }, - "signature": [ - "{ length: number; description: string; }" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 131 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.IUiSettingsClient", "type": "Interface", + "tags": [], "label": "IUiSettingsClient", "description": [ "\nClient-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n{@link IUiSettingsClient}\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.get", "type": "Function", + "tags": [], "label": "get", "description": [ "\nGets the value for a specific uiSetting. If this setting has no user-defined value\nthen the `defaultOverride` parameter is returned (and parsed if setting is of type\n\"json\" or \"number). If the parameter is not defined and the key is not registered\nby any plugin then an error is thrown, otherwise reads the default value defined by a plugin." ], + "signature": [ + "(key: string, defaultOverride?: T | undefined) => T" + ], "source": { "path": "src/core/public/ui_settings/types.ts", "lineNumber": 33 }, - "signature": [ - "(key: string, defaultOverride?: T | undefined) => T" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.get$", "type": "Function", + "tags": [], "label": "get$", "description": [ "\nGets an observable of the current value for a config key, and all updates to that config\nkey in the future. Providing a `defaultOverride` argument behaves the same as it does in #get()" ], - "source": { - "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 39 - }, "signature": [ "(key: string, defaultOverride?: T | undefined) => ", "Observable", "" - ] + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 39 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.getAll", "type": "Function", + "tags": [], "label": "getAll", "description": [ "\nGets the metadata about all uiSettings, including the type, default value, and user value\nfor each key." ], - "source": { - "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 45 - }, "signature": [ "() => Readonly, \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"validation\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\"> & ", "UserProvidedValues", ">>" - ] + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 45 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.set", "type": "Function", + "tags": [], "label": "set", "description": [ "\nSets the value for a uiSetting. If the setting is not registered by any plugin\nit will be stored as a custom setting. The new value will be synchronously available via\nthe `get()` method and sent to the server in the background. If the request to the\nserver fails then a updateErrors$ will be notified and the setting will be\nreverted to its value before `set()` was called." ], + "signature": [ + "(key: string, value: any) => Promise" + ], "source": { "path": "src/core/public/ui_settings/types.ts", "lineNumber": 54 }, - "signature": [ - "(key: string, value: any) => Promise" - ] + "deprecated": false }, { - "tags": [], - "id": "def-public.IUiSettingsClient.overrideLocalDefault", - "type": "Function", - "label": "overrideLocalDefault", - "description": [ - "\nOverrides the default value for a setting in this specific browser tab. If the page\nis reloaded the default override is lost." - ], - "source": { - "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 60 - }, - "signature": [ - "(key: string, newDefault: any) => void" - ] - }, - { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.remove", "type": "Function", + "tags": [], "label": "remove", "description": [ "\nRemoves the user-defined value for a setting, causing it to revert to the default. This\nmethod behaves the same as calling `set(key, null)`, including the synchronization, custom\nsetting, and error behavior of that method." ], + "signature": [ + "(key: string) => Promise" + ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 67 + "lineNumber": 61 }, - "signature": [ - "(key: string) => Promise" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.isDeclared", "type": "Function", + "tags": [], "label": "isDeclared", "description": [ "\nReturns true if the key is a \"known\" uiSetting, meaning it is either registered\nby any plugin or was previously added as a custom setting via the `set()` method." ], + "signature": [ + "(key: string) => boolean" + ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 73 + "lineNumber": 67 }, - "signature": [ - "(key: string) => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.isDefault", "type": "Function", + "tags": [], "label": "isDefault", "description": [ "\nReturns true if the setting has no user-defined value or is unknown" ], + "signature": [ + "(key: string) => boolean" + ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 78 + "lineNumber": 72 }, - "signature": [ - "(key: string) => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.isCustom", "type": "Function", + "tags": [], "label": "isCustom", "description": [ "\nReturns true if the setting wasn't registered by any plugin, but was either\nadded directly via `set()`, or is an unknown setting found in the uiSettings saved\nobject" ], + "signature": [ + "(key: string) => boolean" + ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 85 + "lineNumber": 79 }, - "signature": [ - "(key: string) => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.isOverridden", "type": "Function", + "tags": [], "label": "isOverridden", "description": [ "\nShows whether the uiSettings value set by the user." ], + "signature": [ + "(key: string) => boolean" + ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 90 + "lineNumber": 84 }, - "signature": [ - "(key: string) => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.getUpdate$", "type": "Function", + "tags": [], "label": "getUpdate$", "description": [ "\nReturns an Observable that notifies subscribers of each update to the uiSettings,\nincluding the key, newValue, and oldValue of the setting that changed." ], - "source": { - "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 96 - }, "signature": [ "() => ", "Observable", "<{ key: string; newValue: T; oldValue: T; }>" - ] - }, - { - "tags": [], - "id": "def-public.IUiSettingsClient.getSaved$", - "type": "Function", - "label": "getSaved$", - "description": [ - "\nReturns an Observable that notifies subscribers of each update to the uiSettings,\nincluding the key, newValue, and oldValue of the setting that changed." ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 106 + "lineNumber": 90 }, - "signature": [ - "() => ", - "Observable", - "<{ key: string; newValue: T; oldValue: T; }>" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IUiSettingsClient.getUpdateErrors$", "type": "Function", + "tags": [], "label": "getUpdateErrors$", "description": [ "\nReturns an Observable that notifies subscribers of each error while trying to update\nthe settings, containing the actual Error class." ], - "source": { - "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 116 - }, "signature": [ "() => ", "Observable", "" - ] + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 100 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.NotificationsSetup", "type": "Interface", + "tags": [], "label": "NotificationsSetup", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/notifications/notifications_service.ts", + "lineNumber": 76 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.NotificationsSetup.toasts", "type": "Object", + "tags": [], "label": "toasts", "description": [ "{@link ToastsSetup}" ], - "source": { - "path": "src/core/public/notifications/notifications_service.ts", - "lineNumber": 78 - }, "signature": [ "Pick<", { @@ -2220,36 +2435,38 @@ "text": "ToastsApi" }, ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" - ] + ], + "source": { + "path": "src/core/public/notifications/notifications_service.ts", + "lineNumber": 78 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/notifications/notifications_service.ts", - "lineNumber": 76 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.NotificationsStart", "type": "Interface", + "tags": [], "label": "NotificationsStart", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/notifications/notifications_service.ts", + "lineNumber": 82 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.NotificationsStart.toasts", "type": "Object", + "tags": [], "label": "toasts", "description": [ "{@link ToastsStart}" ], - "source": { - "path": "src/core/public/notifications/notifications_service.ts", - "lineNumber": 84 - }, "signature": [ "Pick<", { @@ -2260,28 +2477,38 @@ "text": "ToastsApi" }, ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" - ] + ], + "source": { + "path": "src/core/public/notifications/notifications_service.ts", + "lineNumber": 84 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/notifications/notifications_service.ts", - "lineNumber": 82 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart", "type": "Interface", + "tags": [], "label": "OverlayBannersStart", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart.add", "type": "Function", + "tags": [], "label": "add", + "description": [ + "\nAdd a new banner\n" + ], "signature": [ "(mount: ", { @@ -2293,15 +2520,19 @@ }, ", priority?: number | undefined) => string" ], - "description": [ - "\nAdd a new banner\n" - ], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart.add.$1", "type": "Function", + "tags": [], "label": "mount", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2312,79 +2543,88 @@ }, "" ], - "description": [], "source": { "path": "src/core/public/overlays/banners/banners_service.tsx", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart.add.$2", "type": "number", + "tags": [], "label": "priority", - "isRequired": false, - "signature": [ - "number | undefined" - ], "description": [ "optional priority order to display this banner. Higher priority values are shown first." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/public/overlays/banners/banners_service.tsx", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [ "a unique identifier for the given banner to be used with {@link OverlayBannersStart.remove} and\n{@link OverlayBannersStart.replace}" - ], - "source": { - "path": "src/core/public/overlays/banners/banners_service.tsx", - "lineNumber": 30 - } + ] }, { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart.remove", "type": "Function", + "tags": [], "label": "remove", - "signature": [ - "(id: string) => boolean" - ], "description": [ "\nRemove a banner\n" ], + "signature": [ + "(id: string) => boolean" + ], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart.remove.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "the unique identifier for the banner returned by {@link OverlayBannersStart.add}" ], + "signature": [ + "string" + ], "source": { "path": "src/core/public/overlays/banners/banners_service.tsx", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "if the banner was found or not" - ], - "source": { - "path": "src/core/public/overlays/banners/banners_service.tsx", - "lineNumber": 38 - } + ] }, { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart.replace", "type": "Function", + "tags": [], "label": "replace", + "description": [ + "\nReplace a banner in place\n" + ], "signature": [ "(id: string | undefined, mount: ", { @@ -2396,31 +2636,38 @@ }, ", priority?: number | undefined) => string" ], - "description": [ - "\nReplace a banner in place\n" - ], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart.replace.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": false, - "signature": [ - "string | undefined" - ], "description": [ "the unique identifier for the banner returned by {@link OverlayBannersStart.add}" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/banners/banners_service.tsx", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart.replace.$2", "type": "Function", + "tags": [], "label": "mount", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2431,176 +2678,196 @@ }, "" ], - "description": [], "source": { "path": "src/core/public/overlays/banners/banners_service.tsx", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart.replace.$3", "type": "number", + "tags": [], "label": "priority", - "isRequired": false, - "signature": [ - "number | undefined" - ], "description": [ "optional priority order to display this banner. Higher priority values are shown first." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/public/overlays/banners/banners_service.tsx", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [ "a new identifier for the given banner to be used with {@link OverlayBannersStart.remove} and\n{@link OverlayBannersStart.replace}" - ], - "source": { - "path": "src/core/public/overlays/banners/banners_service.tsx", - "lineNumber": 49 - } + ] }, { + "parentPluginId": "core", "id": "def-public.OverlayBannersStart.getComponent", "type": "Function", + "tags": [], "label": "getComponent", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/overlays/banners/banners_service.tsx", "lineNumber": 53 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/public/overlays/banners/banners_service.tsx", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.OverlayFlyoutOpenOptions", "type": "Interface", + "tags": [], "label": "OverlayFlyoutOpenOptions", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayFlyoutOpenOptions.className", "type": "string", + "tags": [], "label": "className", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/flyout/flyout_service.tsx", "lineNumber": 81 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayFlyoutOpenOptions.closeButtonAriaLabel", "type": "string", + "tags": [], "label": "closeButtonAriaLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/flyout/flyout_service.tsx", "lineNumber": 82 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayFlyoutOpenOptions.ownFocus", "type": "CompoundType", + "tags": [], "label": "ownFocus", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/overlays/flyout/flyout_service.tsx", "lineNumber": 83 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayFlyoutOpenOptions.datatestsubj", "type": "string", + "tags": [], "label": "'data-test-subj'", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/flyout/flyout_service.tsx", "lineNumber": 84 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayFlyoutOpenOptions.size", "type": "CompoundType", + "tags": [], "label": "size", "description": [], + "signature": [ + "\"m\" | \"s\" | \"l\" | undefined" + ], "source": { "path": "src/core/public/overlays/flyout/flyout_service.tsx", "lineNumber": 85 }, - "signature": [ - "\"m\" | \"s\" | \"l\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayFlyoutOpenOptions.maxWidth", "type": "CompoundType", + "tags": [], "label": "maxWidth", "description": [], + "signature": [ + "string | number | boolean | undefined" + ], "source": { "path": "src/core/public/overlays/flyout/flyout_service.tsx", "lineNumber": 86 }, - "signature": [ - "string | number | boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "lineNumber": 80 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.OverlayFlyoutStart", "type": "Interface", + "tags": [], "label": "OverlayFlyoutStart", "description": [ "\nAPIs to open and manage fly-out dialogs.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.OverlayFlyoutStart.open", "type": "Function", + "tags": [ + "return" + ], "label": "open", + "description": [ + "\nOpens a flyout panel with the given mount point inside. You can use\n`close()` on the returned FlyoutRef to close the flyout.\n" + ], "signature": [ "(mount: ", { @@ -2627,15 +2894,19 @@ "text": "OverlayRef" } ], - "description": [ - "\nOpens a flyout panel with the given mount point inside. You can use\n`close()` on the returned FlyoutRef to close the flyout.\n" - ], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.OverlayFlyoutStart.open.$1", "type": "Function", + "tags": [], "label": "mount", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2646,17 +2917,20 @@ }, "" ], - "description": [], "source": { "path": "src/core/public/overlays/flyout/flyout_service.tsx", "lineNumber": 74 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.OverlayFlyoutStart.open.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2667,260 +2941,287 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/public/overlays/flyout/flyout_service.tsx", "lineNumber": 74 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "lineNumber": 74 - } + "returnComment": [] } ], - "source": { - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "lineNumber": 65 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.OverlayModalConfirmOptions", "type": "Interface", + "tags": [], "label": "OverlayModalConfirmOptions", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalConfirmOptions.title", "type": "string", + "tags": [], "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 54 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalConfirmOptions.cancelButtonText", "type": "string", + "tags": [], "label": "cancelButtonText", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 55 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalConfirmOptions.confirmButtonText", "type": "string", + "tags": [], "label": "confirmButtonText", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 56 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalConfirmOptions.className", "type": "string", + "tags": [], "label": "className", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 57 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalConfirmOptions.closeButtonAriaLabel", "type": "string", + "tags": [], "label": "closeButtonAriaLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 58 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalConfirmOptions.datatestsubj", "type": "string", + "tags": [], "label": "'data-test-subj'", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 59 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalConfirmOptions.defaultFocusedButton", "type": "CompoundType", + "tags": [], "label": "defaultFocusedButton", "description": [], + "signature": [ + "\"cancel\" | \"confirm\" | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 60 }, - "signature": [ - "\"cancel\" | \"confirm\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalConfirmOptions.buttonColor", "type": "CompoundType", + "tags": [], "label": "buttonColor", "description": [], + "signature": [ + "\"warning\" | \"text\" | \"primary\" | \"danger\" | \"secondary\" | \"ghost\" | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 61 }, - "signature": [ - "\"warning\" | \"text\" | \"primary\" | \"danger\" | \"secondary\" | \"ghost\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalConfirmOptions.maxWidth", "type": "CompoundType", + "tags": [], "label": "maxWidth", "description": [ "\nSets the max-width of the modal.\nSet to `true` to use the default (`euiBreakpoints 'm'`),\nset to `false` to not restrict the width,\nset to a number for a custom width in px,\nset to a string for a custom width in custom measurement." ], + "signature": [ + "string | number | boolean | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 69 }, - "signature": [ - "string | number | boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/overlays/modal/modal_service.tsx", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.OverlayModalOpenOptions", "type": "Interface", + "tags": [], "label": "OverlayModalOpenOptions", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 100 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalOpenOptions.className", "type": "string", + "tags": [], "label": "className", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 101 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalOpenOptions.closeButtonAriaLabel", "type": "string", + "tags": [], "label": "closeButtonAriaLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 102 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalOpenOptions.datatestsubj", "type": "string", + "tags": [], "label": "'data-test-subj'", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 103 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayModalOpenOptions.maxWidth", "type": "CompoundType", + "tags": [], "label": "maxWidth", "description": [], + "signature": [ + "string | number | boolean | undefined" + ], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 104 }, - "signature": [ - "string | number | boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/overlays/modal/modal_service.tsx", - "lineNumber": 100 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.OverlayModalStart", "type": "Interface", + "tags": [], "label": "OverlayModalStart", "description": [ "\nAPIs to open and manage modal dialogs.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 77 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.OverlayModalStart.open", "type": "Function", + "tags": [ + "return" + ], "label": "open", + "description": [ + "\nOpens a modal panel with the given mount point inside. You can use\n`close()` on the returned OverlayRef to close the modal.\n" + ], "signature": [ "(mount: ", { @@ -2947,15 +3248,19 @@ "text": "OverlayRef" } ], - "description": [ - "\nOpens a modal panel with the given mount point inside. You can use\n`close()` on the returned OverlayRef to close the modal.\n" - ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.OverlayModalStart.open.$1", "type": "Function", + "tags": [], "label": "mount", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2966,17 +3271,20 @@ }, "" ], - "description": [], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.OverlayModalStart.open.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2987,26 +3295,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/core/public/overlays/modal/modal_service.tsx", - "lineNumber": 86 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.OverlayModalStart.openConfirm", "type": "Function", + "tags": [], "label": "openConfirm", + "description": [ + "\nOpens a confirmation modal with the given text or mountpoint as a message.\nReturns a Promise resolving to `true` if user confirmed or `false` otherwise.\n" + ], "signature": [ "(message: string | ", { @@ -3026,15 +3333,19 @@ }, " | undefined) => Promise" ], - "description": [ - "\nOpens a confirmation modal with the given text or mountpoint as a message.\nReturns a Promise resolving to `true` if user confirmed or `false` otherwise.\n" - ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 94 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.OverlayModalStart.openConfirm.$1", "type": "CompoundType", + "tags": [], "label": "message", - "isRequired": true, + "description": [], "signature": [ "string | ", { @@ -3046,17 +3357,20 @@ }, "" ], - "description": [], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 94 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.OverlayModalStart.openConfirm.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -3067,100 +3381,97 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/public/overlays/modal/modal_service.tsx", "lineNumber": 94 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/overlays/modal/modal_service.tsx", - "lineNumber": 94 - } + "returnComment": [] } ], - "source": { - "path": "src/core/public/overlays/modal/modal_service.tsx", - "lineNumber": 77 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.OverlayRef", "type": "Interface", + "tags": [], "label": "OverlayRef", "description": [ "\nReturned by {@link OverlayStart} methods for closing a mounted overlay." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/overlays/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayRef.onClose", "type": "Object", + "tags": [], "label": "onClose", "description": [ "\nA Promise that will resolve once this overlay is closed.\n\nOverlays can close from user interaction, calling `close()` on the overlay\nreference or another overlay replacing yours via `openModal` or `openFlyout`." ], + "signature": [ + "Promise" + ], "source": { "path": "src/core/public/overlays/types.ts", "lineNumber": 20 }, - "signature": [ - "Promise" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.OverlayRef.close", "type": "Function", + "tags": [], "label": "close", - "signature": [ - "() => Promise" - ], "description": [ "\nCloses the referenced overlay if it's still open which in turn will\nresolve the `onClose` Promise. If the overlay had already been\nclosed this method does nothing." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => Promise" + ], "source": { "path": "src/core/public/overlays/types.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/public/overlays/types.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.OverlayStart", "type": "Interface", + "tags": [], "label": "OverlayStart", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/overlays/overlay_service.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayStart.banners", "type": "Object", + "tags": [], "label": "banners", "description": [ "{@link OverlayBannersStart}" ], - "source": { - "path": "src/core/public/overlays/overlay_service.ts", - "lineNumber": 50 - }, "signature": [ { "pluginId": "core", @@ -3169,20 +3480,22 @@ "section": "def-public.OverlayBannersStart", "text": "OverlayBannersStart" } - ] + ], + "source": { + "path": "src/core/public/overlays/overlay_service.ts", + "lineNumber": 50 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayStart.openFlyout", "type": "Function", + "tags": [], "label": "openFlyout", "description": [ "{@link OverlayFlyoutStart#open}" ], - "source": { - "path": "src/core/public/overlays/overlay_service.ts", - "lineNumber": 52 - }, "signature": [ "(mount: ", { @@ -3208,20 +3521,22 @@ "section": "def-public.OverlayRef", "text": "OverlayRef" } - ] + ], + "source": { + "path": "src/core/public/overlays/overlay_service.ts", + "lineNumber": 52 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayStart.openModal", "type": "Function", + "tags": [], "label": "openModal", "description": [ "{@link OverlayModalStart#open}" ], - "source": { - "path": "src/core/public/overlays/overlay_service.ts", - "lineNumber": 54 - }, "signature": [ "(mount: ", { @@ -3247,20 +3562,22 @@ "section": "def-public.OverlayRef", "text": "OverlayRef" } - ] + ], + "source": { + "path": "src/core/public/overlays/overlay_service.ts", + "lineNumber": 54 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.OverlayStart.openConfirm", "type": "Function", + "tags": [], "label": "openConfirm", "description": [ "{@link OverlayModalStart#openConfirm}" ], - "source": { - "path": "src/core/public/overlays/overlay_service.ts", - "lineNumber": 56 - }, "signature": [ "(message: string | ", { @@ -3279,93 +3596,109 @@ "text": "OverlayModalConfirmOptions" }, " | undefined) => Promise" - ] + ], + "source": { + "path": "src/core/public/overlays/overlay_service.ts", + "lineNumber": 56 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/overlays/overlay_service.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.PackageInfo", "type": "Interface", + "tags": [], "label": "PackageInfo", + "description": [], "signature": [ "PackageInfo" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 4 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.PackageInfo.version", "type": "string", + "tags": [], "label": "version", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 5 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.PackageInfo.branch", "type": "string", + "tags": [], "label": "branch", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 6 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.PackageInfo.buildNum", "type": "number", + "tags": [], "label": "buildNum", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 7 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.PackageInfo.buildSha", "type": "string", + "tags": [], "label": "buildSha", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 8 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.PackageInfo.dist", "type": "boolean", + "tags": [], "label": "dist", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 9 - } + }, + "deprecated": false } ], - "source": { - "path": "node_modules/@kbn/config/target/types.d.ts", - "lineNumber": 4 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.Plugin", "type": "Interface", + "tags": [], "label": "Plugin", + "description": [ + "\nThe interface that should be returned by a `PluginInitializer`.\n" + ], "signature": [ { "pluginId": "core", @@ -3376,17 +3709,19 @@ }, "" ], - "description": [ - "\nThe interface that should be returned by a `PluginInitializer`.\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.Plugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -3398,13 +3733,19 @@ }, ", plugins: TPluginsSetup) => TSetup" ], - "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.Plugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -3415,38 +3756,40 @@ }, "" ], - "description": [], "source": { "path": "src/core/public/plugins/plugin.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.Plugin.setup.$2", "type": "Uncategorized", + "tags": [], "label": "plugins", - "isRequired": true, + "description": [], "signature": [ "TPluginsSetup" ], - "description": [], "source": { "path": "src/core/public/plugins/plugin.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/plugins/plugin.ts", - "lineNumber": 28 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.Plugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -3458,13 +3801,19 @@ }, ", plugins: TPluginsStart) => TStart" ], - "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.Plugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -3474,61 +3823,63 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/core/public/plugins/plugin.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.Plugin.start.$2", "type": "Uncategorized", + "tags": [], "label": "plugins", - "isRequired": true, + "description": [], "signature": [ "TPluginsStart" ], - "description": [], "source": { "path": "src/core/public/plugins/plugin.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/plugins/plugin.ts", - "lineNumber": 29 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.Plugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "(() => void) | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/plugins/plugin.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/public/plugins/plugin.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.PluginInitializerContext", "type": "Interface", + "tags": [], "label": "PluginInitializerContext", + "description": [ + "\nThe available core services passed to a `PluginInitializer`\n" + ], "signature": [ { "pluginId": "core", @@ -3539,83 +3890,91 @@ }, "" ], - "description": [ - "\nThe available core services passed to a `PluginInitializer`\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/plugins/plugin_context.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.PluginInitializerContext.opaqueId", "type": "Uncategorized", + "tags": [], "label": "opaqueId", "description": [ "\nA symbol used to identify this plugin in the system. Needed when registering handlers or context providers." ], + "signature": [ + "symbol" + ], "source": { "path": "src/core/public/plugins/plugin_context.ts", "lineNumber": 26 }, - "signature": [ - "symbol" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.PluginInitializerContext.env", "type": "Object", + "tags": [], "label": "env", "description": [], - "source": { - "path": "src/core/public/plugins/plugin_context.ts", - "lineNumber": 27 - }, "signature": [ "{ mode: Readonly<", "EnvironmentMode", ">; packageInfo: Readonly<", "PackageInfo", ">; }" - ] - }, + ], + "source": { + "path": "src/core/public/plugins/plugin_context.ts", + "lineNumber": 27 + }, + "deprecated": false + }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.PluginInitializerContext.config", "type": "Object", + "tags": [], "label": "config", "description": [], + "signature": [ + "{ get: () => T; }" + ], "source": { "path": "src/core/public/plugins/plugin_context.ts", "lineNumber": 31 }, - "signature": [ - "{ get: () => T; }" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/plugins/plugin_context.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObject", "type": "Interface", + "tags": [], "label": "SavedObject", + "description": [], "signature": [ "SavedObject", "" ], - "description": [], - "tags": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "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`" @@ -3623,12 +3982,14 @@ "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 71 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "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." @@ -3636,511 +3997,567 @@ "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 73 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.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" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 75 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObject.updated_at", "type": "string", + "tags": [], "label": "updated_at", "description": [ "Timestamp of the last time this document had been updated." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 77 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObject.error", "type": "Object", + "tags": [], "label": "error", "description": [], + "signature": [ + "SavedObjectError", + " | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 78 }, - "signature": [ - "SavedObjectError", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObject.attributes", "type": "Uncategorized", + "tags": [], "label": "attributes", "description": [ "{@inheritdoc SavedObjectAttributes}" ], + "signature": [ + "T" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 80 }, - "signature": [ - "T" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObject.references", "type": "Array", + "tags": [], "label": "references", "description": [ "{@inheritdoc SavedObjectReference}" ], + "signature": [ + "SavedObjectReference", + "[]" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 82 }, - "signature": [ - "SavedObjectReference", - "[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObject.migrationVersion", "type": "Object", + "tags": [], "label": "migrationVersion", "description": [ "{@inheritdoc SavedObjectsMigrationVersion}" ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 84 }, - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "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" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 86 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObject.namespaces", "type": "Array", + "tags": [], "label": "namespaces", "description": [ "Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 88 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "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" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 95 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 69 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectAttributes", "type": "Interface", + "tags": [], "label": "SavedObjectAttributes", "description": [ "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectAttributes.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 36 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectError", "type": "Interface", + "tags": [], "label": "SavedObjectError", "description": [], - "tags": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectError.error", "type": "string", + "tags": [], "label": "error", "description": [], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 99 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectError.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 100 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectError.statusCode", "type": "number", + "tags": [], "label": "statusCode", "description": [], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 101 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectError.metadata", "type": "Object", + "tags": [], "label": "metadata", "description": [], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 102 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 98 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectReference", "type": "Interface", + "tags": [], "label": "SavedObjectReference", "description": [ "\nA reference to another saved object.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectReference.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 45 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectReference.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 46 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectReference.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 47 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsBaseOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsBaseOptions", "description": [ "\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 162 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBaseOptions.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [ "Specify the namespace for this operation" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 142 + "lineNumber": 164 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 140 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsFindOptions", "description": [ "\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 78 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 79 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.page", "type": "number", + "tags": [], "label": "page", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 80 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 81 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.sortField", "type": "string", + "tags": [], "label": "sortField", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 82 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.sortOrder", "type": "CompoundType", + "tags": [], "label": "sortOrder", "description": [], + "signature": [ + "\"asc\" | \"desc\" | \"_doc\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 83 }, - "signature": [ - "\"asc\" | \"desc\" | \"_doc\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.fields", "type": "Array", + "tags": [], "label": "fields", "description": [ "\nAn array of fields to include in the results" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 89 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.search", "type": "string", + "tags": [], "label": "search", "description": [ "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 91 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.searchFields", "type": "Array", + "tags": [], "label": "searchFields", "description": [ "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 93 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.searchAfter", "type": "Array", + "tags": [], "label": "searchAfter", "description": [ "\nUse the sort values from the previous page to retrieve the next page of results." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 97 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.rootSearchFields", "type": "Array", + "tags": [], "label": "rootSearchFields", "description": [ "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 102 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.hasReference", "type": "CompoundType", + "tags": [], "label": "hasReference", "description": [ "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 108 - }, "signature": [ { "pluginId": "core", @@ -4158,112 +4575,148 @@ "text": "SavedObjectsFindOptionsReference" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 108 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.hasReferenceOperator", "type": "CompoundType", + "tags": [], "label": "hasReferenceOperator", "description": [ "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" ], + "signature": [ + "\"AND\" | \"OR\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 112 }, - "signature": [ - "\"AND\" | \"OR\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.defaultSearchOperator", "type": "CompoundType", + "tags": [], "label": "defaultSearchOperator", "description": [ "\nThe search operator to use with the provided filter. Defaults to `OR`" ], + "signature": [ + "\"AND\" | \"OR\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 117 }, - "signature": [ - "\"AND\" | \"OR\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.filter", "type": "Any", + "tags": [], "label": "filter", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 118 }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptions.aggs", + "type": "Object", + "tags": [ + "alpha" + ], + "label": "aggs", + "description": [ + "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + ], "signature": [ - "any" - ] + "Record | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 140 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.namespaces", "type": "Array", + "tags": [], "label": "namespaces", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 119 + "lineNumber": 141 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.typeToNamespacesMap", "type": "Object", + "tags": [], "label": "typeToNamespacesMap", "description": [ "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." ], + "signature": [ + "Map | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 127 + "lineNumber": 149 }, - "signature": [ - "Map | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.preference", "type": "string", + "tags": [], "label": "preference", "description": [ "An optional ES preference value to be used for the query" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 129 + "lineNumber": 151 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptions.pit", "type": "Object", + "tags": [], "label": "pit", "description": [ "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 133 - }, "signature": [ { "pluginId": "core", @@ -4273,82 +4726,94 @@ "text": "SavedObjectsPitParams" }, " | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 155 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 78 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptionsReference", "type": "Interface", + "tags": [], "label": "SavedObjectsFindOptionsReference", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptionsReference.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 62 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindOptionsReference.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 63 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 61 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportActionRequiredWarning", "type": "Interface", + "tags": [], "label": "SavedObjectsImportActionRequiredWarning", "description": [ "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 200 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportActionRequiredWarning.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"action_required\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 201 }, - "signature": [ - "\"action_required\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportActionRequiredWarning.message", "type": "string", + "tags": [], "label": "message", "description": [ "The translated message to display to the user." @@ -4356,12 +4821,14 @@ "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 203 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportActionRequiredWarning.actionPath", "type": "string", + "tags": [], "label": "actionPath", "description": [ "The path (without the basePath) that the user should be redirect to address this warning." @@ -4369,212 +4836,231 @@ "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 205 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportActionRequiredWarning.buttonLabel", "type": "string", + "tags": [], "label": "buttonLabel", "description": [ "An optional label to use for the link button. If unspecified, a default label will be used." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 207 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 200 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportAmbiguousConflictError", "type": "Interface", + "tags": [], "label": "SavedObjectsImportAmbiguousConflictError", "description": [ "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportAmbiguousConflictError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"ambiguous_conflict\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 54 }, - "signature": [ - "\"ambiguous_conflict\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportAmbiguousConflictError.destinations", "type": "Array", + "tags": [], "label": "destinations", "description": [], + "signature": [ + "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 55 }, - "signature": [ - "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportConflictError", "type": "Interface", + "tags": [], "label": "SavedObjectsImportConflictError", "description": [ "\nRepresents a failure to import due to a conflict." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportConflictError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"conflict\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 45 }, - "signature": [ - "\"conflict\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportConflictError.destinationId", "type": "string", + "tags": [], "label": "destinationId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 46 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportFailure", "type": "Interface", + "tags": [], "label": "SavedObjectsImportFailure", "description": [ "\nRepresents a failure to import." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 89 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportFailure.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 90 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportFailure.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 91 - } + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.title", + "type": "string", "tags": [ "deprecated" ], - "id": "def-public.SavedObjectsImportFailure.title", - "type": "string", "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 95 }, - "signature": [ - "string | undefined" - ] + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportFailure.meta", "type": "Object", + "tags": [], "label": "meta", "description": [], + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 96 }, - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportFailure.overwrite", "type": "CompoundType", + "tags": [], "label": "overwrite", "description": [ "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 100 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportFailure.error", "type": "CompoundType", + "tags": [], "label": "error", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 101 - }, "signature": [ { "pluginId": "core", @@ -4615,104 +5101,114 @@ "section": "def-server.SavedObjectsImportUnknownError", "text": "SavedObjectsImportUnknownError" } - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 101 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 89 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportMissingReferencesError", "type": "Interface", + "tags": [], "label": "SavedObjectsImportMissingReferencesError", "description": [ "\nRepresents a failure to import due to missing references." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportMissingReferencesError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"missing_references\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 81 }, - "signature": [ - "\"missing_references\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportMissingReferencesError.references", "type": "Array", + "tags": [], "label": "references", "description": [], + "signature": [ + "{ type: string; id: string; }[]" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 82 }, - "signature": [ - "{ type: string; id: string; }[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 80 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsImportResponse", "description": [ "\nThe response describing the result of an import." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 141 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportResponse.success", "type": "boolean", + "tags": [], "label": "success", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 142 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportResponse.successCount", "type": "number", + "tags": [], "label": "successCount", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 143 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportResponse.successResults", "type": "Array", + "tags": [], "label": "successResults", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 144 - }, "signature": [ { "pluginId": "core", @@ -4722,18 +5218,20 @@ "text": "SavedObjectsImportSuccess" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 144 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportResponse.warnings", "type": "Array", + "tags": [], "label": "warnings", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 145 - }, "signature": [ { "pluginId": "core", @@ -4743,18 +5241,20 @@ "text": "SavedObjectsImportWarning" }, "[]" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 145 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportResponse.errors", "type": "Array", + "tags": [], "label": "errors", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 146 - }, "signature": [ { "pluginId": "core", @@ -4764,157 +5264,179 @@ "text": "SavedObjectsImportFailure" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 146 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 141 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportRetry", "type": "Interface", + "tags": [], "label": "SavedObjectsImportRetry", "description": [ "\nDescribes a retry operation for importing a saved object." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportRetry.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportRetry.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportRetry.overwrite", "type": "boolean", + "tags": [], "label": "overwrite", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportRetry.destinationId", "type": "string", + "tags": [], "label": "destinationId", "description": [ "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 23 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportRetry.replaceReferences", "type": "Array", + "tags": [], "label": "replaceReferences", "description": [], + "signature": [ + "{ type: string; from: string; to: string; }[]" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 24 }, - "signature": [ - "{ type: string; from: string; to: string; }[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportRetry.createNewCopy", "type": "CompoundType", + "tags": [], "label": "createNewCopy", "description": [ "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 33 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportRetry.ignoreMissingReferences", "type": "CompoundType", + "tags": [], "label": "ignoreMissingReferences", "description": [ "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 37 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportSimpleWarning", "type": "Interface", + "tags": [], "label": "SavedObjectsImportSimpleWarning", "description": [ "\nA simple informative warning that will be displayed to the user.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 186 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportSimpleWarning.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"simple\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 187 }, - "signature": [ - "\"simple\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportSimpleWarning.message", "type": "string", + "tags": [], "label": "message", "description": [ "The translated message to display to the user" @@ -4922,570 +5444,640 @@ "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 189 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 186 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportSuccess", "type": "Interface", + "tags": [], "label": "SavedObjectsImportSuccess", "description": [ "\nRepresents a successful import." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 113 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportSuccess.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 114 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportSuccess.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 115 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportSuccess.destinationId", "type": "string", + "tags": [], "label": "destinationId", "description": [ "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 119 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSuccess.createNewCopy", + "type": "CompoundType", "tags": [ "deprecated" ], - "id": "def-public.SavedObjectsImportSuccess.createNewCopy", - "type": "CompoundType", "label": "createNewCopy", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 126 }, - "signature": [ - "boolean | undefined" + "deprecated": true, + "references": [ + { + "plugin": "savedObjectsManagement", + "link": { + "path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts", + "lineNumber": 223 + } + }, + { + "plugin": "spaces", + "link": { + "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx", + "lineNumber": 142 + } + } ] }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportSuccess.meta", "type": "Object", + "tags": [], "label": "meta", "description": [], + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 127 }, - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportSuccess.overwrite", "type": "CompoundType", + "tags": [], "label": "overwrite", "description": [ "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 134 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 113 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportUnknownError", "type": "Interface", + "tags": [], "label": "SavedObjectsImportUnknownError", "description": [ "\nRepresents a failure to import due to an unknown reason." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportUnknownError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"unknown\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 71 }, - "signature": [ - "\"unknown\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportUnknownError.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 72 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportUnknownError.statusCode", "type": "number", + "tags": [], "label": "statusCode", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 73 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 70 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportUnsupportedTypeError", "type": "Interface", + "tags": [], "label": "SavedObjectsImportUnsupportedTypeError", "description": [ "\nRepresents a failure to import due to having an unsupported saved object type." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsImportUnsupportedTypeError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"unsupported_type\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 63 }, - "signature": [ - "\"unsupported_type\"" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 62 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsMigrationVersion", "type": "Interface", + "tags": [], "label": "SavedObjectsMigrationVersion", "description": [ "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsMigrationVersion.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 66 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 65 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.StringValidationRegex", "type": "Interface", + "tags": [], "label": "StringValidationRegex", "description": [ "\nStringValidation with regex object" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 114 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.StringValidationRegex.regex", "type": "Object", + "tags": [], "label": "regex", "description": [], + "signature": [ + "RegExp" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 115 }, - "signature": [ - "RegExp" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.StringValidationRegex.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 116 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 114 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.StringValidationRegexString", "type": "Interface", + "tags": [], "label": "StringValidationRegexString", "description": [ "\nStringValidation as regex string" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 123 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.StringValidationRegexString.regexString", "type": "string", + "tags": [], "label": "regexString", "description": [], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 124 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.StringValidationRegexString.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 125 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 123 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ToastOptions", "type": "Interface", + "tags": [], "label": "ToastOptions", "description": [ "\nOptions available for {@link IToasts} APIs." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ToastOptions.toastLifeTimeMs", "type": "number", + "tags": [], "label": "toastLifeTimeMs", "description": [ "\nHow long should the toast remain on screen." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 51 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 47 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.UiSettingsParams", "type": "Interface", + "tags": [], "label": "UiSettingsParams", - "signature": [ - "UiSettingsParams", - "" - ], "description": [ "\nUiSettings parameters defined by the plugins." ], - "tags": [ - "public" + "signature": [ + "UiSettingsParams", + "" ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.name", "type": "string", + "tags": [], "label": "name", "description": [ "title in the UI" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 45 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.value", "type": "Uncategorized", + "tags": [], "label": "value", "description": [ "default value to fall back to if a user doesn't provide any" ], + "signature": [ + "T | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 47 }, - "signature": [ - "T | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.description", "type": "string", + "tags": [], "label": "description", "description": [ "description provided to a user in UI" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 49 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.category", "type": "Array", + "tags": [], "label": "category", "description": [ "used to group the configured setting in the UI" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 51 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.options", "type": "Array", + "tags": [], "label": "options", "description": [ "array of permitted values for this setting" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 53 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.optionLabels", "type": "Object", + "tags": [], "label": "optionLabels", "description": [ "text labels for 'select' type UI element" ], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 55 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.requiresPageReload", "type": "CompoundType", + "tags": [], "label": "requiresPageReload", "description": [ "a flag indicating whether new value applying requires page reloading" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 57 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.readonly", "type": "CompoundType", + "tags": [], "label": "readonly", "description": [ "a flag indicating that value cannot be changed" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 59 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.sensitive", "type": "CompoundType", + "tags": [], "label": "sensitive", "description": [ "\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 64 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [ "defines a type of UI element {@link UiSettingsType}" ], + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 66 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.deprecation", "type": "Object", + "tags": [], "label": "deprecation", "description": [ "optional deprecation information. Used to generate a deprecation warning." ], + "signature": [ + "DeprecationSettings", + " | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 68 }, - "signature": [ - "DeprecationSettings", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.order", "type": "number", + "tags": [], "label": "order", "description": [ "\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n" ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 75 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.validation", "type": "CompoundType", + "tags": [], "label": "validation", "description": [], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 81 - }, "signature": [ "ImageValidation", " | ", @@ -5493,185 +6085,219 @@ " | ", "StringValidationRegexString", " | undefined" - ] + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 81 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UiSettingsParams.schema", "type": "Object", + "tags": [], "label": "schema", "description": [], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 86 - }, "signature": [ "Type", "" - ] + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 86 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.metric", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-public.UiSettingsParams.metric", - "type": "Object", "label": "metric", "description": [ "\nMetric to track once this property changes" ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 92 - }, "signature": [ "{ type: ", "UiCounterMetricType", "; name: string; } | undefined" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 92 + }, + "deprecated": true, + "references": [ + { + "plugin": "advancedSettings", + "link": { + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", + "lineNumber": 69 + } + } ] } ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 43 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.UiSettingsState", "type": "Interface", + "tags": [], "label": "UiSettingsState", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.UiSettingsState.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/public/ui_settings/types.ts", "lineNumber": 14 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.UserProvidedValues", "type": "Interface", + "tags": [], "label": "UserProvidedValues", - "signature": [ - "UserProvidedValues", - "" - ], "description": [ "\nDescribes the values explicitly set by user." ], - "tags": [ - "public" + "signature": [ + "UserProvidedValues", + "" ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 142 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.UserProvidedValues.userValue", "type": "Uncategorized", + "tags": [], "label": "userValue", "description": [], + "signature": [ + "T | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 143 }, - "signature": [ - "T | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.UserProvidedValues.isOverridden", "type": "CompoundType", + "tags": [], "label": "isOverridden", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 144 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 142 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "core", + "id": "def-public.APP_WRAPPER_CLASS", + "type": "string", + "tags": [], + "label": "APP_WRAPPER_CLASS", + "description": [ + "\nThe class name for top level *and* nested application wrappers to ensure proper layout" + ], + "signature": [ + "\"kbnAppWrapper\"" + ], + "source": { + "path": "src/core/utils/app_wrapper_class.ts", + "lineNumber": 13 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", "id": "def-public.FatalErrorsStart", "type": "Type", + "tags": [], "label": "FatalErrorsStart", - "tags": [ - "public" - ], "description": [ "\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n" ], + "signature": [ + "FatalErrorsSetup" + ], "source": { "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", "lineNumber": 52 }, - "signature": [ - "FatalErrorsSetup" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.IToasts", "type": "Type", + "tags": [], "label": "IToasts", - "tags": [ - "public" - ], "description": [ "\nMethods for adding and removing global toast messages. See {@link ToastsApi}." ], + "signature": [ + "{ get$: () => Rx.Observable; add: (toastOrTitle: ToastInput) => Toast; remove: (toastOrId: string | Toast) => void; addSuccess: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addWarning: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addDanger: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addError: (error: Error, options: ErrorToastOptions) => Toast; addInfo: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; }" + ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 85 }, - "signature": [ - "{ get$: () => Rx.Observable; add: (toastOrTitle: ToastInput) => Toast; remove: (toastOrId: string | Toast) => void; addSuccess: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addWarning: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addDanger: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addError: (error: Error, options: ErrorToastOptions) => Toast; addInfo: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.MountPoint", "type": "Type", + "tags": [], "label": "MountPoint", - "tags": [ - "public" - ], "description": [ "\nA function that should mount DOM content inside the provided container element\nand return a handler to unmount it.\n" ], - "source": { - "path": "src/core/public/types.ts", - "lineNumber": 27 - }, "signature": [ "(element: T) => ", { @@ -5682,22 +6308,22 @@ "text": "UnmountCallback" } ], + "source": { + "path": "src/core/public/types.ts", + "lineNumber": 27 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.PluginInitializer", "type": "Type", + "tags": [], "label": "PluginInitializer", - "tags": [ - "public" - ], "description": [ "\nThe `plugin` export at the root of a plugin's `public` directory should conform\nto this interface.\n" ], - "source": { - "path": "src/core/public/plugins/plugin.ts", - "lineNumber": 56 - }, "signature": [ "(core: ", { @@ -5725,73 +6351,75 @@ }, "" ], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 56 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.PluginOpaqueId", "type": "Type", + "tags": [], "label": "PluginOpaqueId", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 84 - }, "signature": [ "symbol" ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 117 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.PublicUiSettingsParams", "type": "Type", + "tags": [], "label": "PublicUiSettingsParams", - "tags": [ - "public" - ], "description": [ "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." ], + "signature": [ + "{ type?: \"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined; options?: string[] | undefined; description?: string | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; category?: string[] | undefined; metric?: { type: UiCounterMetricType; name: string; } | undefined; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; }" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 102 }, - "signature": [ - "{ type?: \"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined; options?: string[] | undefined; description?: string | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; category?: string[] | undefined; metric?: { type: UiCounterMetricType; name: string; } | undefined; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ResolveDeprecationResponse", "type": "Type", - "label": "ResolveDeprecationResponse", "tags": [], + "label": "ResolveDeprecationResponse", "description": [], + "signature": [ + "{ status: \"ok\"; } | { status: \"fail\"; reason: string; }" + ], "source": { "path": "src/core/public/deprecations/deprecations_client.ts", "lineNumber": 18 }, - "signature": [ - "{ status: \"ok\"; } | { status: \"fail\"; reason: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectAttribute", "type": "Type", + "tags": [], "label": "SavedObjectAttribute", - "tags": [ - "public" - ], "description": [ "\nType definition for a Saved Object attribute value\n" ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 27 - }, "signature": [ "undefined | null | string | number | false | true | ", "SavedObjectAttributes", @@ -5799,42 +6427,42 @@ "SavedObjectAttributeSingle", "[]" ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 27 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectAttributeSingle", "type": "Type", + "tags": [], "label": "SavedObjectAttributeSingle", - "tags": [ - "public" - ], "description": [ "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 14 - }, "signature": [ "undefined | null | string | number | false | true | ", "SavedObjectAttributes" ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 14 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsImportWarning", "type": "Type", + "tags": [], "label": "SavedObjectsImportWarning", - "tags": [ - "public" - ], "description": [ "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 218 - }, "signature": [ { "pluginId": "core", @@ -5852,41 +6480,41 @@ "text": "SavedObjectsImportActionRequiredWarning" } ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 218 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsNamespaceType", "type": "Type", + "tags": [], "label": "SavedObjectsNamespaceType", - "tags": [ - "public" - ], "description": [ "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 227 - }, "signature": [ "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 249 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.StartServicesAccessor", "type": "Type", + "tags": [], "label": "StartServicesAccessor", - "tags": [ - "public" - ], "description": [ "\nAllows plugins to get access to APIs available in start inside async\nhandlers, such as {@link App.mount}. Promise will not resolve until Core\nand plugin dependencies have completed `start`.\n" ], - "source": { - "path": "src/core/public/index.ts", - "lineNumber": 239 - }, "signature": [ "() => Promise<[", { @@ -5898,58 +6526,60 @@ }, ", TPluginsStart, TStart]>" ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 244 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.StringValidation", "type": "Type", + "tags": [], "label": "StringValidation", - "tags": [ - "public" - ], "description": [ "\nAllows regex objects or a regex string" ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 108 - }, "signature": [ "StringValidationRegex", " | ", "StringValidationRegexString" ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 108 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.Toast", "type": "Type", - "label": "Toast", "tags": [], + "label": "Toast", "description": [], + "signature": [ + "Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; } & { id: string; }" + ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 33 }, - "signature": [ - "Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; } & { id: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ToastInput", "type": "Type", + "tags": [], "label": "ToastInput", - "tags": [ - "public" - ], "description": [ "\nInputs for {@link IToasts} APIs." ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "lineNumber": 41 - }, "signature": [ "string | ", { @@ -5960,41 +6590,41 @@ "text": "ToastInputFields" } ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 41 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ToastInputFields", "type": "Type", + "tags": [], "label": "ToastInputFields", - "tags": [ - "public" - ], "description": [ "\nAllowed fields for {@link ToastInput}.\n" ], + "signature": [ + "Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; }" + ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", "lineNumber": 28 }, - "signature": [ - "Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ToastsSetup", "type": "Type", + "tags": [], "label": "ToastsSetup", - "tags": [ - "public" - ], "description": [ "\n{@link IToasts}" ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_service.tsx", - "lineNumber": 32 - }, "signature": [ "{ get$: () => ", "Observable", @@ -6031,22 +6661,22 @@ "text": "Toast" } ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "lineNumber": 32 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ToastsStart", "type": "Type", + "tags": [], "label": "ToastsStart", - "tags": [ - "public" - ], "description": [ "\n{@link IToasts}" ], - "source": { - "path": "src/core/public/notifications/toasts/toasts_service.tsx", - "lineNumber": 38 - }, "signature": [ "{ get$: () => ", "Observable", @@ -6083,63 +6713,68 @@ "text": "Toast" } ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "lineNumber": 38 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.UiSettingsType", "type": "Type", + "tags": [], "label": "UiSettingsType", - "tags": [ - "public" - ], "description": [ "\nUI element type to represent the settings." ], + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\"" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 16 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.UnmountCallback", "type": "Type", + "tags": [], "label": "UnmountCallback", - "tags": [ - "public" - ], "description": [ "\nA function that will unmount the element previously mounted by\nthe associated {@link MountPoint}\n" ], + "signature": [ + "() => void" + ], "source": { "path": "src/core/public/types.ts", "lineNumber": 35 }, - "signature": [ - "() => void" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [ - "public" - ], + "parentPluginId": "core", "id": "def-public.URL_MAX_LENGTH", "type": "CompoundType", + "tags": [], "label": "URL_MAX_LENGTH", "description": [ "\nThe max URL length allowed by the current browser. Should be used to display warnings to users when query parameters\ncause URL to exceed this limit." ], + "signature": [ + "2000 | 25000" + ], "source": { "path": "src/core/public/core_app/errors/url_overflow.tsx", "lineNumber": 27 }, - "signature": [ - "2000 | 25000" - ], + "deprecated": false, "initialIsOpen": false } ], @@ -6148,11 +6783,10 @@ "server": { "classes": [ { + "parentPluginId": "core", "id": "def-server.CspConfig", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "CspConfig", "description": [ "\nCSP configuration for use in Kibana." @@ -6174,17 +6808,19 @@ "text": "ICspConfig" } ], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 52 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.CspConfig.DEFAULT", "type": "Object", + "tags": [], "label": "DEFAULT", "description": [], - "source": { - "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 47 - }, "signature": [ { "pluginId": "core", @@ -6193,93 +6829,122 @@ "section": "def-server.CspConfig", "text": "CspConfig" } - ] + ], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 53 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.CspConfig.rules", "type": "Array", + "tags": [], "label": "rules", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 49 + "lineNumber": 55 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.CspConfig.strict", "type": "boolean", + "tags": [], "label": "strict", "description": [], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 50 - } + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.CspConfig.warnLegacyBrowsers", "type": "boolean", + "tags": [], "label": "warnLegacyBrowsers", "description": [], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 51 - } + "lineNumber": 57 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.CspConfig.disableEmbedding", + "type": "boolean", "tags": [], + "label": "disableEmbedding", + "description": [], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 58 + }, + "deprecated": false + }, + { + "parentPluginId": "core", "id": "def-server.CspConfig.header", "type": "string", + "tags": [], "label": "header", "description": [], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 52 - } + "lineNumber": 59 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 46 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "ElasticsearchConfig", "description": [ "\nWrapper of config schema." ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 188 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.healthCheckDelay", "type": "Object", + "tags": [], "label": "healthCheckDelay", "description": [ "\nThe interval between health check requests Kibana sends to the Elasticsearch." ], + "signature": [ + "moment.Duration" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 192 }, - "signature": [ - "moment.Duration" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.ignoreVersionMismatch", "type": "boolean", + "tags": [], "label": "ignoreVersionMismatch", "description": [ "\nWhether to allow kibana to connect to a non-compatible elasticsearch node." @@ -6287,12 +6952,14 @@ "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 197 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.apiVersion", "type": "string", + "tags": [], "label": "apiVersion", "description": [ "\nVersion of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to." @@ -6300,92 +6967,104 @@ "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 202 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.hosts", "type": "Array", + "tags": [], "label": "hosts", "description": [ "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." ], + "signature": [ + "string[]" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 208 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.requestHeadersWhitelist", "type": "Array", + "tags": [], "label": "requestHeadersWhitelist", "description": [ "\nList of Kibana client-side headers to send to Elasticsearch when request\nscoped cluster client is used. If this is an empty array then *no* client-side\nwill be sent." ], + "signature": [ + "string[]" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 215 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.pingTimeout", "type": "Object", + "tags": [], "label": "pingTimeout", "description": [ "\nTimeout after which PING HTTP request will be aborted and retried." ], + "signature": [ + "moment.Duration" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 220 }, - "signature": [ - "moment.Duration" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.requestTimeout", "type": "Object", + "tags": [], "label": "requestTimeout", "description": [ "\nTimeout after which HTTP request will be aborted and retried." ], + "signature": [ + "moment.Duration" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 225 }, - "signature": [ - "moment.Duration" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.shardTimeout", "type": "Object", + "tags": [], "label": "shardTimeout", "description": [ "\nTimeout for Elasticsearch to wait for responses from shards. Set to 0 to disable." ], + "signature": [ + "moment.Duration" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 230 }, - "signature": [ - "moment.Duration" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.sniffOnStart", "type": "boolean", + "tags": [], "label": "sniffOnStart", "description": [ "\nSpecifies whether the client should attempt to detect the rest of the cluster\nwhen it is first instantiated." @@ -6393,28 +7072,32 @@ "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 236 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.sniffInterval", "type": "CompoundType", + "tags": [], "label": "sniffInterval", "description": [ "\nInterval to perform a sniff operation and make sure the list of nodes is complete.\nIf `false` then sniffing is disabled." ], + "signature": [ + "false | moment.Duration" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 242 }, - "signature": [ - "false | moment.Duration" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.sniffOnConnectionFault", "type": "boolean", + "tags": [], "label": "sniffOnConnectionFault", "description": [ "\nSpecifies whether the client should immediately sniff for a more current list\nof nodes when a connection dies." @@ -6422,116 +7105,126 @@ "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 248 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.username", "type": "string", + "tags": [], "label": "username", "description": [ "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe username that the Kibana server uses to perform its administrative functions." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 254 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.password", "type": "string", + "tags": [], "label": "password", "description": [ "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe password that the Kibana server uses to perform its administrative functions." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 260 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.ssl", "type": "CompoundType", + "tags": [], "label": "ssl", "description": [ "\nSet of settings configure SSL connection between Kibana and Elasticsearch that\nare required when `xpack.ssl.verification_mode` in Elasticsearch is set to\neither `certificate` or `full`." ], + "signature": [ + "Pick; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 267 }, - "signature": [ - "Pick; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.customHeaders", "type": "Object", + "tags": [], "label": "customHeaders", "description": [ "\nHeader names and values to send to Elasticsearch with every request. These\nheaders cannot be overwritten by client-side headers and aren't affected by\n`requestHeadersWhitelist` configuration." ], + "signature": [ + "Record" + ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 277 }, - "signature": [ - "Record" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 279 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.Unnamed.$1", "type": "Object", + "tags": [], "label": "rawConfig", - "isRequired": true, + "description": [], "signature": [ "Readonly<{ password?: string | undefined; username?: string | undefined; } & { ssl: Readonly<{ key?: string | undefined; certificate?: string | undefined; certificateAuthorities?: string | string[] | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"certificate\" | \"full\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; hosts: string | string[]; requestHeadersWhitelist: string | string[]; customHeaders: Record; logQueries: boolean; apiVersion: string; healthCheck: Readonly<{} & { delay: moment.Duration; }>; ignoreVersionMismatch: boolean; }>" ], - "description": [], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "lineNumber": 279 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 279 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 188 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient", "type": "Class", "tags": [ - "deprecated", - "public" + "deprecated" ], "label": "LegacyClusterClient", "description": [ @@ -6555,21 +7248,36 @@ }, ", \"callAsInternalUser\" | \"asScoped\">" ], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 104 + }, + "deprecated": true, + "references": [], "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 121 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.Unnamed.$1", "type": "CompoundType", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6579,45 +7287,54 @@ "text": "LegacyElasticsearchClientConfig" } ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", "lineNumber": 122 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.Unnamed.$2", "type": "Object", + "tags": [], "label": "log", - "isRequired": true, + "description": [], "signature": [ "Logger" ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", "lineNumber": 123 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.Unnamed.$3", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", "lineNumber": 124 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.Unnamed.$4", "type": "Function", + "tags": [], "label": "getAuthHeaders", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6627,57 +7344,311 @@ "text": "GetAuthHeaders" } ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", "lineNumber": 125 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 121 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.callAsInternalUser", "type": "Function", + "tags": [ + "deprecated" + ], + "label": "callAsInternalUser", + "description": [ + "\nCalls specified endpoint with provided clientParams on behalf of the\nKibana internal user.\nSee {@link LegacyAPICaller}." + ], + "signature": [ + "(endpoint: string, clientParams?: Record, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyCallAPIOptions", + "text": "LegacyCallAPIOptions" + }, + " | undefined) => Promise" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 140 + }, + "deprecated": true, + "references": [ + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 106 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 110 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 182 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts", + "lineNumber": 125 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts", + "lineNumber": 218 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts", + "lineNumber": 235 + } + }, + { + "plugin": "beatsManagement", + "link": { + "path": "x-pack/plugins/beats_management/server/lib/adapters/database/kibana_database_adapter.ts", + "lineNumber": 113 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_usage_collector.ts", + "lineNumber": 107 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/register_monitoring_telemetry_collection.ts", + "lineNumber": 148 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 73 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 87 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 97 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 98 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 108 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 127 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 142 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 159 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 176 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 187 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 192 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 218 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 249 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 258 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 261 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 265 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 284 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 293 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 303 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 306 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 328 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 334 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 338 + } + } + ], "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.callAsInternalUser.$1", "type": "string", + "tags": [], "label": "endpoint", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", "lineNumber": 141 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.callAsInternalUser.$2", "type": "Object", + "tags": [], "label": "clientParams", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", "lineNumber": 142 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.callAsInternalUser.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -6688,59 +7659,45 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", "lineNumber": 143 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(endpoint: string, clientParams?: Record, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyCallAPIOptions", - "text": "LegacyCallAPIOptions" - }, - " | undefined) => Promise" - ], - "description": [ - "\nCalls specified endpoint with provided clientParams on behalf of the\nKibana internal user.\nSee {@link LegacyAPICaller}." - ], - "label": "callAsInternalUser", - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 140 - }, - "tags": [ - "deprecated" - ], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.close", "type": "Function", + "tags": [], "label": "close", - "signature": [ - "() => void" - ], "description": [ "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", "lineNumber": 158 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.asScoped", "type": "Function", + "tags": [], "label": "asScoped", + "description": [ + "\nCreates an instance of {@link ILegacyScopedClusterClient} based on the configuration the\ncurrent cluster client that exposes additional `callAsCurrentUser` method\nscoped to the provided req. Consumers shouldn't worry about closing\nscoped client instances, these will be automatically closed as soon as the\noriginal cluster client isn't needed anymore and closed.\n" + ], "signature": [ "(request?: ", { @@ -6776,15 +7733,21 @@ }, ", \"callAsCurrentUser\" | \"callAsInternalUser\">" ], - "description": [ - "\nCreates an instance of {@link ILegacyScopedClusterClient} based on the configuration the\ncurrent cluster client that exposes additional `callAsCurrentUser` method\nscoped to the provided req. Consumers shouldn't worry about closing\nscoped client instances, these will be automatically closed as soon as the\noriginal cluster client isn't needed anymore and closed.\n" - ], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 181 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyClusterClient.asScoped.$1", "type": "CompoundType", + "tags": [], "label": "request", - "isRequired": false, + "description": [ + "- Request the `IScopedClusterClient` instance will be scoped to.\nSupports request optionality, Legacy.Request & FakeRequest for BWC with LegacyPlatform" + ], "signature": [ { "pluginId": "core", @@ -6811,44 +7774,41 @@ }, " | undefined" ], - "description": [ - "- Request the `IScopedClusterClient` instance will be scoped to.\nSupports request optionality, Legacy.Request & FakeRequest for BWC with LegacyPlatform" - ], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", "lineNumber": 181 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 181 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 104 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LegacyElasticsearchErrorHelpers", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "LegacyElasticsearchErrorHelpers", "description": [ "\nHelpers for working with errors returned from the Elasticsearch service.Since the internal data of\nerrors are subject to change, consumers of the Elasticsearch service should always use these helpers\nto classify errors instead of checking error internals such as `body.error.header[WWW-Authenticate]`" ], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyElasticsearchErrorHelpers.isNotAuthorizedError", "type": "Function", + "tags": [], "label": "isNotAuthorizedError", + "description": [], "signature": [ "typeof ", { @@ -6860,34 +7820,39 @@ }, ".isNotAuthorizedError" ], - "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyElasticsearchErrorHelpers.isNotAuthorizedError.$1", "type": "Any", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/errors.ts", "lineNumber": 70 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/errors.ts", - "lineNumber": 70 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.LegacyElasticsearchErrorHelpers.decorateNotAuthorizedError", "type": "Function", + "tags": [], "label": "decorateNotAuthorizedError", + "description": [], "signature": [ "typeof ", { @@ -6899,57 +7864,58 @@ }, ".decorateNotAuthorizedError" ], - "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyElasticsearchErrorHelpers.decorateNotAuthorizedError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/errors.ts", "lineNumber": 74 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.LegacyElasticsearchErrorHelpers.decorateNotAuthorizedError.$2", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/errors.ts", "lineNumber": 74 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/errors.ts", - "lineNumber": 74 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/elasticsearch/legacy/errors.ts", - "lineNumber": 69 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient", "type": "Class", "tags": [ - "deprecated", - "public" + "deprecated" ], "label": "LegacyScopedClusterClient", "description": [ @@ -6973,21 +7939,65 @@ }, ", \"callAsCurrentUser\" | \"callAsInternalUser\">" ], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 34 + }, + "deprecated": true, + "references": [ + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 9 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 40 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/target/types/server/types.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/target/types/server/types.d.ts", + "lineNumber": 25 + } + } + ], "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient.Unnamed.$1", "type": "Function", + "tags": [], "label": "internalAPICaller", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6997,17 +8007,20 @@ "text": "LegacyAPICaller" } ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient.Unnamed.$2", "type": "Function", + "tags": [], "label": "scopedAPICaller", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -7017,17 +8030,20 @@ "text": "LegacyAPICaller" } ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", "lineNumber": 37 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient.Unnamed.$3", "type": "CompoundType", + "tags": [], "label": "headers", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -7038,24 +8054,27 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 35 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient.callAsInternalUser", "type": "Function", + "tags": [ + "deprecated" + ], "label": "callAsInternalUser", + "description": [ + "\nCalls specified `endpoint` with provided `clientParams` on behalf of the\nKibana internal user.\nSee {@link LegacyAPICaller}." + ], "signature": [ "(endpoint: string, clientParams?: Record, options?: ", { @@ -7067,47 +8086,82 @@ }, " | undefined) => Promise" ], - "description": [ - "\nCalls specified `endpoint` with provided `clientParams` on behalf of the\nKibana internal user.\nSee {@link LegacyAPICaller}." + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 54 + }, + "deprecated": true, + "references": [ + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 102 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 103 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 120 + } + } ], "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient.callAsInternalUser.$1", "type": "string", + "tags": [], "label": "endpoint", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`." ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient.callAsInternalUser.$2", "type": "Object", + "tags": [], "label": "clientParams", - "isRequired": true, - "signature": [ - "Record" - ], "description": [ "- A dictionary of parameters that will be passed directly to the Elasticsearch JS client." ], + "signature": [ + "Record" + ], "source": { "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", "lineNumber": 56 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient.callAsInternalUser.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [ + "- Options that affect the way we call the API and process the result." + ], "signature": [ { "pluginId": "core", @@ -7118,28 +8172,27 @@ }, " | undefined" ], - "description": [ - "- Options that affect the way we call the API and process the result." - ], "source": { "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "deprecated" - ], - "returnComment": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 54 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser", "type": "Function", + "tags": [ + "deprecated" + ], "label": "callAsCurrentUser", + "description": [ + "\nCalls specified `endpoint` with provided `clientParams` on behalf of the\nuser initiated request to the Kibana server (via HTTP request headers).\nSee {@link LegacyAPICaller}." + ], "signature": [ "(endpoint: string, clientParams?: Record, options?: ", { @@ -7151,5592 +8204,7936 @@ }, " | undefined) => Promise" ], - "description": [ - "\nCalls specified `endpoint` with provided `clientParams` on behalf of the\nuser initiated request to the Kibana server (via HTTP request headers).\nSee {@link LegacyAPICaller}." - ], - "children": [ + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 72 + }, + "deprecated": true, + "references": [ { - "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser.$1", - "type": "string", - "label": "endpoint", - "isRequired": true, - "signature": [ - "string" - ], - "description": [ - "- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`." - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 73 + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 113 } }, { - "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser.$2", - "type": "Object", - "label": "clientParams", - "isRequired": true, - "signature": [ - "Record" - ], - "description": [ - "- A dictionary of parameters that will be passed directly to the Elasticsearch JS client." - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 74 + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 114 } }, { - "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser.$3", - "type": "Object", - "label": "options", - "isRequired": false, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyCallAPIOptions", - "text": "LegacyCallAPIOptions" - }, - " | undefined" - ], - "description": [ - "- Options that affect the way we call the API and process the result." - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 75 + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 115 } - } - ], - "tags": [ - "deprecated" - ], - "returnComment": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 72 - } - } - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 34 - }, - "initialIsOpen": false - } - ], - "functions": [], - "interfaces": [ - { - "id": "def-server.AppCategory", - "type": "Interface", - "label": "AppCategory", - "description": [ - "\n\nA category definition for nav links to know where to sort them in the left hand nav" - ], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "id": "def-server.AppCategory.id", - "type": "string", - "label": "id", - "description": [ - "\nUnique identifier for the categories" - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 19 - } - }, - { - "tags": [], - "id": "def-server.AppCategory.label", - "type": "string", - "label": "label", - "description": [ - "\nLabel used for category name.\nAlso used as aria-label if one isn't set." - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 25 - } - }, - { - "tags": [], - "id": "def-server.AppCategory.ariaLabel", - "type": "string", - "label": "ariaLabel", - "description": [ - "\nIf the visual label isn't appropriate for screen readers,\ncan override it here" - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 31 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.AppCategory.order", - "type": "number", - "label": "order", - "description": [ - "\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)" - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 38 - }, - "signature": [ - "number | undefined" - ] - }, - { - "tags": [], - "id": "def-server.AppCategory.euiIconType", - "type": "string", - "label": "euiIconType", - "description": [ - "\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined" - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 45 - }, - "signature": [ - "string | undefined" - ] - } - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 15 - }, - "initialIsOpen": false - }, - { - "id": "def-server.AssistanceAPIResponse", - "type": "Interface", - "label": "AssistanceAPIResponse", - "description": [], - "tags": [ - "deprecated", - "public" - ], - "children": [ - { - "tags": [], - "id": "def-server.AssistanceAPIResponse.indices", - "type": "Object", - "label": "indices", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 338 - }, - "signature": [ - "{ [indexName: string]: { action_required: ", + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MIGRATION_ASSISTANCE_INDEX_ACTION", - "text": "MIGRATION_ASSISTANCE_INDEX_ACTION" + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 118 + } }, - "; }; }" - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 337 - }, - "initialIsOpen": false - }, - { - "id": "def-server.AssistantAPIClientParams", - "type": "Interface", - "label": "AssistantAPIClientParams", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.AssistantAPIClientParams", - "text": "AssistantAPIClientParams" - }, - " extends ", - "GenericParams" - ], - "description": [], - "tags": [ - "deprecated", - "public" - ], - "children": [ - { - "tags": [], - "id": "def-server.AssistantAPIClientParams.path", - "type": "string", - "label": "path", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 318 - }, - "signature": [ - "\"/_migration/assistance\"" - ] - }, - { - "tags": [], - "id": "def-server.AssistantAPIClientParams.method", - "type": "string", - "label": "method", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 319 - }, - "signature": [ - "\"GET\"" - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 317 - }, - "initialIsOpen": false - }, - { - "id": "def-server.AsyncPlugin", - "type": "Interface", - "label": "AsyncPlugin", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.AsyncPlugin", - "text": "AsyncPlugin" - }, - "" - ], - "description": [ - "\nA plugin with asynchronous lifecycle methods.\n" - ], - "tags": [ - "deprecated", - "public" - ], - "children": [ - { - "id": "def-server.AsyncPlugin.setup", - "type": "Function", - "label": "setup", - "signature": [ - "(core: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" + "plugin": "data", + "link": { + "path": "src/plugins/data/server/autocomplete/value_suggestions_route.ts", + "lineNumber": 67 + } }, - ", plugins: TPluginsSetup) => TSetup | Promise" - ], - "description": [], - "children": [ { - "id": "def-server.AsyncPlugin.setup.$1", - "type": "Object", - "label": "core", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "" - ], - "description": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 274 + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/framework/kibana_framework_adapter.ts", + "lineNumber": 34 } }, { - "id": "def-server.AsyncPlugin.setup.$2", - "type": "Uncategorized", - "label": "plugins", - "isRequired": true, - "signature": [ - "TPluginsSetup" - ], - "description": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 274 + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.ts", + "lineNumber": 51 } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 274 - } - }, - { - "id": "def-server.AsyncPlugin.start", - "type": "Function", - "label": "start", - "signature": [ - "(core: ", + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts", + "lineNumber": 58 + } }, - ", plugins: TPluginsStart) => TStart | Promise" - ], - "description": [], - "children": [ { - "id": "def-server.AsyncPlugin.start.$1", - "type": "Object", - "label": "core", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - } - ], - "description": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 276 + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/privileges/read_privileges_route.ts", + "lineNumber": 39 } }, { - "id": "def-server.AsyncPlugin.start.$2", - "type": "Uncategorized", - "label": "plugins", - "isRequired": true, - "signature": [ - "TPluginsStart" - ], - "description": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 276 + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/handlers.ts", + "lineNumber": 114 } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 276 - } - }, - { - "id": "def-server.AsyncPlugin.stop", - "type": "Function", - "label": "stop", - "signature": [ - "(() => void) | undefined" - ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 278 - } - } - ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 268 - }, - "initialIsOpen": false - }, - { - "id": "def-server.Capabilities", - "type": "Interface", - "label": "Capabilities", - "description": [ - "\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n" - ], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "id": "def-server.Capabilities.navLinks", - "type": "Object", - "label": "navLinks", - "description": [ - "Navigation link capabilities." - ], - "source": { - "path": "src/core/types/capabilities.ts", - "lineNumber": 18 - }, - "signature": [ - "Record" - ] - }, - { - "tags": [], - "id": "def-server.Capabilities.management", - "type": "Object", - "label": "management", - "description": [ - "Management section capabilities." - ], - "source": { - "path": "src/core/types/capabilities.ts", - "lineNumber": 21 - }, - "signature": [ - "{ [sectionId: string]: Record; }" - ] - }, - { - "tags": [], - "id": "def-server.Capabilities.catalogue", - "type": "Object", - "label": "catalogue", - "description": [ - "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." - ], - "source": { - "path": "src/core/types/capabilities.ts", - "lineNumber": 26 - }, - "signature": [ - "Record" - ] - }, - { - "id": "def-server.Capabilities.Unnamed", - "type": "Any", - "label": "Unnamed", - "tags": [], - "description": [ - "Custom capabilities, registered by plugins." - ], - "source": { - "path": "src/core/types/capabilities.ts", - "lineNumber": 29 - }, - "signature": [ - "any" - ] - } - ], - "source": { - "path": "src/core/types/capabilities.ts", - "lineNumber": 16 - }, - "initialIsOpen": false - }, - { - "id": "def-server.CapabilitiesSetup", - "type": "Interface", - "label": "CapabilitiesSetup", - "description": [ - "\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n" - ], - "tags": [ - "public" - ], - "children": [ - { - "id": "def-server.CapabilitiesSetup.registerProvider", - "type": "Function", - "label": "registerProvider", - "signature": [ - "(provider: ", + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesProvider", - "text": "CapabilitiesProvider" + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/handlers.ts", + "lineNumber": 181 + } }, - ") => void" - ], - "description": [ - "\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n" - ], - "children": [ { - "id": "def-server.CapabilitiesSetup.registerProvider.$1", - "type": "Function", - "label": "provider", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesProvider", - "text": "CapabilitiesProvider" - } - ], - "description": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 54 + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/policy/service.ts", + "lineNumber": 55 } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 54 - } - }, - { - "id": "def-server.CapabilitiesSetup.registerSwitcher", - "type": "Function", - "label": "registerSwitcher", - "signature": [ - "(switcher: ", + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSwitcher", - "text": "CapabilitiesSwitcher" + "plugin": "lists", + "link": { + "path": "x-pack/plugins/lists/server/routes/read_privileges_route.ts", + "lineNumber": 31 + } }, - ") => void" - ], - "description": [ - "\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n" - ], - "children": [ { - "id": "def-server.CapabilitiesSetup.registerSwitcher.$1", - "type": "Function", - "label": "switcher", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSwitcher", - "text": "CapabilitiesSwitcher" - } - ], - "description": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 93 + "plugin": "lists", + "link": { + "path": "x-pack/plugins/lists/server/routes/read_privileges_route.ts", + "lineNumber": 35 } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 93 - } - } - ], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 30 - }, - "initialIsOpen": false - }, - { - "id": "def-server.CapabilitiesStart", - "type": "Interface", - "label": "CapabilitiesStart", - "description": [ - "\nAPIs to access the application {@link Capabilities}.\n" - ], - "tags": [ - "public" - ], - "children": [ - { - "id": "def-server.CapabilitiesStart.resolveCapabilities", - "type": "Function", - "label": "resolveCapabilities", - "signature": [ - "(request: ", + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "plugin": "beatsManagement", + "link": { + "path": "x-pack/plugins/beats_management/server/lib/adapters/database/kibana_database_adapter.ts", + "lineNumber": 111 + } }, - ", options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ResolveCapabilitiesOptions", - "text": "ResolveCapabilitiesOptions" + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/routes/es_fields/es_fields.ts", + "lineNumber": 31 + } }, - " | undefined) => Promise<", - "Capabilities", - ">" - ], - "description": [ - "\nResolve the {@link Capabilities} to be used for given request" - ], - "children": [ { - "id": "def-server.CapabilitiesStart.resolveCapabilities.$1", - "type": "Object", - "label": "request", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "description": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 118 + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts", + "lineNumber": 64 } }, { - "id": "def-server.CapabilitiesStart.resolveCapabilities.$2", - "type": "Object", - "label": "options", - "isRequired": false, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ResolveCapabilitiesOptions", - "text": "ResolveCapabilitiesOptions" - }, - " | undefined" - ], - "description": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 119 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/data_streams/register_delete_route.ts", + "lineNumber": 25 } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 117 - } - } - ], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 113 - }, - "initialIsOpen": false - }, - { - "id": "def-server.ConfigDeprecationFactory", - "type": "Interface", - "label": "ConfigDeprecationFactory", - "signature": [ - "ConfigDeprecationFactory" - ], - "description": [ - "\nProvides helpers to generates the most commonly used {@link ConfigDeprecation}\nwhen invoking a {@link ConfigDeprecationProvider}.\n\nSee methods documentation for more detailed examples.\n" - ], - "tags": [ - "public" - ], - "children": [ - { - "id": "def-server.ConfigDeprecationFactory.rename", - "type": "Function", - "label": "rename", - "signature": [ - "(oldKey: string, newKey: string, details?: Partial<", - "DeprecatedConfigDetails", - "> | undefined) => ", - "ConfigDeprecation" - ], - "description": [ - "\nRename a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n" - ], - "children": [ + }, { - "id": "def-server.ConfigDeprecationFactory.rename.$1", - "type": "string", - "label": "oldKey", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 80 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_clear_cache_route.ts", + "lineNumber": 31 } }, { - "id": "def-server.ConfigDeprecationFactory.rename.$2", - "type": "string", - "label": "newKey", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 80 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_close_route.ts", + "lineNumber": 31 } }, { - "id": "def-server.ConfigDeprecationFactory.rename.$3", - "type": "Object", - "label": "details", - "isRequired": false, - "signature": [ - "Partial<", - "DeprecatedConfigDetails", - "> | undefined" - ], - "description": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 80 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_flush_route.ts", + "lineNumber": 31 } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 80 - } - }, - { - "id": "def-server.ConfigDeprecationFactory.renameFromRoot", - "type": "Function", - "label": "renameFromRoot", - "signature": [ - "(oldKey: string, newKey: string, details?: Partial<", - "DeprecatedConfigDetails", - "> | undefined) => ", - "ConfigDeprecation" - ], - "description": [ - "\nRename a configuration property from the root configuration.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n\nThis should be only used when renaming properties from different configuration's path.\nTo rename properties from inside a plugin's configuration, use 'rename' instead.\n" - ], - "children": [ + }, { - "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$1", - "type": "string", - "label": "oldKey", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 96 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_forcemerge_route.ts", + "lineNumber": 38 } }, { - "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$2", - "type": "string", - "label": "newKey", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 96 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_list_route.ts", + "lineNumber": 18 } }, { - "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$3", - "type": "Object", - "label": "details", - "isRequired": false, - "signature": [ - "Partial<", - "DeprecatedConfigDetails", - "> | undefined" - ], - "description": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 96 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_open_route.ts", + "lineNumber": 31 } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 96 - } - }, - { - "id": "def-server.ConfigDeprecationFactory.unused", - "type": "Function", - "label": "unused", - "signature": [ - "(unusedKey: string, details?: Partial<", - "DeprecatedConfigDetails", - "> | undefined) => ", - "ConfigDeprecation" - ], - "description": [ - "\nRemove a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n" - ], - "children": [ + }, { - "id": "def-server.ConfigDeprecationFactory.unused.$1", - "type": "string", - "label": "unusedKey", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 109 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_refresh_route.ts", + "lineNumber": 31 } }, { - "id": "def-server.ConfigDeprecationFactory.unused.$2", - "type": "Object", - "label": "details", - "isRequired": false, - "signature": [ - "Partial<", - "DeprecatedConfigDetails", - "> | undefined" - ], - "description": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 109 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_reload_route.ts", + "lineNumber": 33 } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 109 - } - }, - { - "id": "def-server.ConfigDeprecationFactory.unusedFromRoot", - "type": "Function", - "label": "unusedFromRoot", - "signature": [ - "(unusedKey: string, details?: Partial<", - "DeprecatedConfigDetails", - "> | undefined) => ", - "ConfigDeprecation" - ], - "description": [ - "\nRemove a configuration property from the root configuration.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n\nThis should be only used when removing properties from outside of a plugin's configuration.\nTo remove properties from inside a plugin's configuration, use 'unused' instead.\n" - ], - "children": [ + }, { - "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$1", - "type": "string", - "label": "unusedKey", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 125 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_delete_route.ts", + "lineNumber": 31 } }, { - "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$2", - "type": "Object", - "label": "details", - "isRequired": false, - "signature": [ - "Partial<", - "DeprecatedConfigDetails", - "> | undefined" - ], - "description": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 125 + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_freeze_route.ts", + "lineNumber": 30 } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 125 - } - } - ], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 67 - }, - "initialIsOpen": false - }, - { - "id": "def-server.ContextSetup", - "type": "Interface", - "label": "ContextSetup", - "description": [ - "\n{@inheritdoc IContextContainer}\n" - ], - "tags": [ - "public" - ], - "children": [ - { - "id": "def-server.ContextSetup.createContextContainer", - "type": "Function", - "label": "createContextContainer", - "signature": [ - "() => ", + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextContainer", - "text": "IContextContainer" - } + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/indices/register_unfreeze_route.ts", + "lineNumber": 28 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/templates/register_get_routes.ts", + "lineNumber": 24 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/templates/register_get_routes.ts", + "lineNumber": 65 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/templates/register_delete_route.ts", + "lineNumber": 32 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/templates/register_create_route.ts", + "lineNumber": 22 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/templates/register_update_route.ts", + "lineNumber": 28 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/templates/register_simulate_route.ts", + "lineNumber": 22 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/mapping/register_mapping_route.ts", + "lineNumber": 35 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/settings/register_load_route.ts", + "lineNumber": 38 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/settings/register_update_route.ts", + "lineNumber": 36 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/stats/register_stats_route.ts", + "lineNumber": 37 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/component_templates/get.ts", + "lineNumber": 27 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/component_templates/get.ts", + "lineNumber": 71 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/component_templates/create.ts", + "lineNumber": 28 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/component_templates/update.ts", + "lineNumber": 32 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/component_templates/delete.ts", + "lineNumber": 26 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/routes/api/component_templates/privileges.ts", + "lineNumber": 48 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_create_route.ts", + "lineNumber": 45 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_create_route.ts", + "lineNumber": 64 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_delete_route.ts", + "lineNumber": 50 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_fetch_route.ts", + "lineNumber": 27 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_get_route.ts", + "lineNumber": 37 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_pause_route.ts", + "lineNumber": 49 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_resume_route.ts", + "lineNumber": 49 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_update_route.ts", + "lineNumber": 47 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_create_route.ts", + "lineNumber": 52 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_fetch_route.ts", + "lineNumber": 29 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_fetch_route.ts", + "lineNumber": 35 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_get_route.ts", + "lineNumber": 38 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_get_route.ts", + "lineNumber": 58 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_pause_route.ts", + "lineNumber": 47 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_resume_route.ts", + "lineNumber": 47 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_unfollow_route.ts", + "lineNumber": 50 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_unfollow_route.ts", + "lineNumber": 59 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_unfollow_route.ts", + "lineNumber": 64 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_unfollow_route.ts", + "lineNumber": 72 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_update_route.ts", + "lineNumber": 53 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_update_route.ts", + "lineNumber": 66 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_update_route.ts", + "lineNumber": 80 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/cross_cluster_replication/register_permissions_route.ts", + "lineNumber": 40 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/cross_cluster_replication/register_stats_route.ts", + "lineNumber": 29 + } + }, + { + "plugin": "infra", + "link": { + "path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts", + "lineNumber": 420 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_usage_collector.ts", + "lineNumber": 106 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/register_monitoring_telemetry_collection.ts", + "lineNumber": 147 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/plugin.ts", + "lineNumber": 356 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/routes/es_fields/es_fields.test.ts", + "lineNumber": 70 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/routes/es_fields/es_fields.test.ts", + "lineNumber": 98 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/routes/es_fields/es_fields.test.ts", + "lineNumber": 126 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/routes/es_fields/es_fields.test.ts", + "lineNumber": 146 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/routes/api/v1/alerts/enable.ts", + "lineNumber": 96 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/routes/api/v1/elasticsearch_settings/check/internal_monitoring.ts", + "lineNumber": 48 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 122 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 134 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 160 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 172 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 217 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 229 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 261 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 274 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 276 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 318 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 331 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 334 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 352 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 396 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 414 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 434 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 446 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 473 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 485 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 506 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 518 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 534 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 549 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 113 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 125 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 154 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 167 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 169 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 208 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 221 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 224 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 243 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 284 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 302 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 322 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 334 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 360 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 372 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 393 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 405 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 421 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 436 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/policy/handlers.test.ts", + "lineNumber": 55 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/policy/handlers.test.ts", + "lineNumber": 74 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/privileges/read_privileges_route.test.ts", + "lineNumber": 20 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/privileges/read_privileges_route.test.ts", + "lineNumber": 63 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/add_prepackaged_rules_route.test.ts", + "lineNumber": 93 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/create_rules_bulk_route.test.ts", + "lineNumber": 38 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/create_rules_route.test.ts", + "lineNumber": 40 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/get_prepackaged_rules_status_route.test.ts", + "lineNumber": 77 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/import_rules_route.test.ts", + "lineNumber": 48 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals.test.ts", + "lineNumber": 28 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals.test.ts", + "lineNumber": 56 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.test.ts", + "lineNumber": 28 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.test.ts", + "lineNumber": 38 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.test.ts", + "lineNumber": 48 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.test.ts", + "lineNumber": 58 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.test.ts", + "lineNumber": 70 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/timeline/routes/prepackaged_timelines/install_prepackaged_timelines/helpers.test.ts", + "lineNumber": 50 + } + } + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser.$1", + "type": "string", + "tags": [], + "label": "endpoint", + "description": [ + "- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`." + ], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 73 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser.$2", + "type": "Object", + "tags": [], + "label": "clientParams", + "description": [ + "- A dictionary of parameters that will be passed directly to the Elasticsearch JS client." + ], + "signature": [ + "Record" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 74 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- Options that affect the way we call the API and process the result." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyCallAPIOptions", + "text": "LegacyCallAPIOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 75 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "core", + "id": "def-server.AppCategory", + "type": "Interface", + "tags": [], + "label": "AppCategory", + "description": [ + "\n\nA category definition for nav links to know where to sort them in the left hand nav" + ], + "source": { + "path": "src/core/types/app_category.ts", + "lineNumber": 15 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AppCategory.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nUnique identifier for the categories" + ], + "source": { + "path": "src/core/types/app_category.ts", + "lineNumber": 19 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AppCategory.label", + "type": "string", + "tags": [], + "label": "label", + "description": [ + "\nLabel used for category name.\nAlso used as aria-label if one isn't set." + ], + "source": { + "path": "src/core/types/app_category.ts", + "lineNumber": 25 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AppCategory.ariaLabel", + "type": "string", + "tags": [], + "label": "ariaLabel", + "description": [ + "\nIf the visual label isn't appropriate for screen readers,\ncan override it here" + ], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/types/app_category.ts", + "lineNumber": 31 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AppCategory.order", + "type": "number", + "tags": [], + "label": "order", + "description": [ + "\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)" + ], + "signature": [ + "number | undefined" + ], + "source": { + "path": "src/core/types/app_category.ts", + "lineNumber": 38 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AppCategory.euiIconType", + "type": "string", + "tags": [], + "label": "euiIconType", + "description": [ + "\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined" + ], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/types/app_category.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AssistanceAPIResponse", + "type": "Interface", + "tags": [ + "deprecated" + ], + "label": "AssistanceAPIResponse", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 337 + }, + "deprecated": true, + "references": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AssistanceAPIResponse.indices", + "type": "Object", + "tags": [], + "label": "indices", + "description": [], + "signature": [ + "{ [indexName: string]: { action_required: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MIGRATION_ASSISTANCE_INDEX_ACTION", + "text": "MIGRATION_ASSISTANCE_INDEX_ACTION" + }, + "; }; }" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 338 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AssistantAPIClientParams", + "type": "Interface", + "tags": [ + "deprecated" + ], + "label": "AssistantAPIClientParams", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.AssistantAPIClientParams", + "text": "AssistantAPIClientParams" + }, + " extends ", + "GenericParams" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 317 + }, + "deprecated": true, + "references": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AssistantAPIClientParams.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "\"/_migration/assistance\"" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 318 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AssistantAPIClientParams.method", + "type": "string", + "tags": [], + "label": "method", + "description": [], + "signature": [ + "\"GET\"" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 319 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin", + "type": "Interface", + "tags": [ + "deprecated" + ], + "label": "AsyncPlugin", + "description": [ + "\nA plugin with asynchronous lifecycle methods.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.AsyncPlugin", + "text": "AsyncPlugin" + }, + "" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 301 + }, + "deprecated": true, + "references": [ + { + "plugin": "fleet", + "link": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 15 + } + }, + { + "plugin": "fleet", + "link": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 189 + } + }, + { + "plugin": "fleet", + "link": { + "path": "x-pack/plugins/fleet/target/types/server/plugin.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "fleet", + "link": { + "path": "x-pack/plugins/fleet/target/types/server/plugin.d.ts", + "lineNumber": 83 + } + } + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ", plugins: TPluginsSetup) => TSetup | Promise" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 307 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 307 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.setup.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsSetup" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 307 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", plugins: TPluginsStart) => TStart | Promise" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 309 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.start.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 309 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.start.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsStart" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 309 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 311 + }, + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.Capabilities", + "type": "Interface", + "tags": [], + "label": "Capabilities", + "description": [ + "\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n" + ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 16 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.Capabilities.navLinks", + "type": "Object", + "tags": [], + "label": "navLinks", + "description": [ + "Navigation link capabilities." + ], + "signature": [ + "Record" + ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 18 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.Capabilities.management", + "type": "Object", + "tags": [], + "label": "management", + "description": [ + "Management section capabilities." + ], + "signature": [ + "{ [sectionId: string]: Record; }" + ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 21 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.Capabilities.catalogue", + "type": "Object", + "tags": [], + "label": "catalogue", + "description": [ + "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." + ], + "signature": [ + "Record" + ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 26 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.Capabilities.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [ + "Custom capabilities, registered by plugins." + ], + "signature": [ + "any" + ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup", + "type": "Interface", + "tags": [], + "label": "CapabilitiesSetup", + "description": [ + "\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n" + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 30 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup.registerProvider", + "type": "Function", + "tags": [], + "label": "registerProvider", + "description": [ + "\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n" + ], + "signature": [ + "(provider: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesProvider", + "text": "CapabilitiesProvider" + }, + ") => void" + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 54 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup.registerProvider.$1", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesProvider", + "text": "CapabilitiesProvider" + } + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 54 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup.registerSwitcher", + "type": "Function", + "tags": [], + "label": "registerSwitcher", + "description": [ + "\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n" + ], + "signature": [ + "(switcher: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + }, + ") => void" + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 93 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup.registerSwitcher.$1", + "type": "Function", + "tags": [], + "label": "switcher", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + } + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 93 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesStart", + "type": "Interface", + "tags": [], + "label": "CapabilitiesStart", + "description": [ + "\nAPIs to access the application {@link Capabilities}.\n" + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 113 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesStart.resolveCapabilities", + "type": "Function", + "tags": [], + "label": "resolveCapabilities", + "description": [ + "\nResolve the {@link Capabilities} to be used for given request" + ], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" + }, + " | undefined) => Promise<", + "Capabilities", + ">" + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 117 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesStart.resolveCapabilities.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 118 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesStart.resolveCapabilities.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 119 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory", + "type": "Interface", + "tags": [], + "label": "ConfigDeprecationFactory", + "description": [ + "\nProvides helpers to generates the most commonly used {@link ConfigDeprecation}\nwhen invoking a {@link ConfigDeprecationProvider}.\n\nSee methods documentation for more detailed examples.\n" + ], + "signature": [ + "ConfigDeprecationFactory" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 67 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.rename", + "type": "Function", + "tags": [], + "label": "rename", + "description": [ + "\nRename a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n" + ], + "signature": [ + "(oldKey: string, newKey: string, details?: Partial<", + "DeprecatedConfigDetails", + "> | undefined) => ", + "ConfigDeprecation" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 80 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.rename.$1", + "type": "string", + "tags": [], + "label": "oldKey", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 80 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.rename.$2", + "type": "string", + "tags": [], + "label": "newKey", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 80 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.rename.$3", + "type": "Object", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "Partial<", + "DeprecatedConfigDetails", + "> | undefined" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 80 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot", + "type": "Function", + "tags": [], + "label": "renameFromRoot", + "description": [ + "\nRename a configuration property from the root configuration.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n\nThis should be only used when renaming properties from different configuration's path.\nTo rename properties from inside a plugin's configuration, use 'rename' instead.\n" + ], + "signature": [ + "(oldKey: string, newKey: string, details?: Partial<", + "DeprecatedConfigDetails", + "> | undefined) => ", + "ConfigDeprecation" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 96 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$1", + "type": "string", + "tags": [], + "label": "oldKey", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 96 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$2", + "type": "string", + "tags": [], + "label": "newKey", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 96 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$3", + "type": "Object", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "Partial<", + "DeprecatedConfigDetails", + "> | undefined" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 96 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unused", + "type": "Function", + "tags": [], + "label": "unused", + "description": [ + "\nRemove a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n" + ], + "signature": [ + "(unusedKey: string, details?: Partial<", + "DeprecatedConfigDetails", + "> | undefined) => ", + "ConfigDeprecation" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 109 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unused.$1", + "type": "string", + "tags": [], + "label": "unusedKey", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 109 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unused.$2", + "type": "Object", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "Partial<", + "DeprecatedConfigDetails", + "> | undefined" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 109 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot", + "type": "Function", + "tags": [], + "label": "unusedFromRoot", + "description": [ + "\nRemove a configuration property from the root configuration.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n\nThis should be only used when removing properties from outside of a plugin's configuration.\nTo remove properties from inside a plugin's configuration, use 'unused' instead.\n" + ], + "signature": [ + "(unusedKey: string, details?: Partial<", + "DeprecatedConfigDetails", + "> | undefined) => ", + "ConfigDeprecation" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 125 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$1", + "type": "string", + "tags": [], + "label": "unusedKey", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 125 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$2", + "type": "Object", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "Partial<", + "DeprecatedConfigDetails", + "> | undefined" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 125 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ContextSetup", + "type": "Interface", + "tags": [], + "label": "ContextSetup", + "description": [ + "\n{@inheritdoc IContextContainer}\n" + ], + "source": { + "path": "src/core/server/context/context_service.ts", + "lineNumber": 92 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ContextSetup.createContextContainer", + "type": "Function", + "tags": [], + "label": "createContextContainer", + "description": [ + "\nCreates a new {@link IContextContainer} for a service owner." + ], + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IContextContainer", + "text": "IContextContainer" + } + ], + "source": { + "path": "src/core/server/context/context_service.ts", + "lineNumber": 96 + }, + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup", + "type": "Interface", + "tags": [], + "label": "CoreSetup", + "description": [ + "\nContext passed to the plugins `setup` method.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 472 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.capabilities", + "type": "Object", + "tags": [], + "label": "capabilities", + "description": [ + "{@link CapabilitiesSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesSetup", + "text": "CapabilitiesSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 474 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [ + "{@link ContextSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ContextSetup", + "text": "ContextSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 476 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.elasticsearch", + "type": "Object", + "tags": [], + "label": "elasticsearch", + "description": [ + "{@link ElasticsearchServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchServiceSetup", + "text": "ElasticsearchServiceSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 478 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.http", + "type": "CompoundType", + "tags": [], + "label": "http", + "description": [ + "{@link HttpServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpServiceSetup", + "text": "HttpServiceSetup" + }, + " & { resources: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResources", + "text": "HttpResources" + }, + "; }" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 480 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.i18n", + "type": "Object", + "tags": [], + "label": "i18n", + "description": [ + "{@link I18nServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.I18nServiceSetup", + "text": "I18nServiceSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 485 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.logging", + "type": "Object", + "tags": [], + "label": "logging", + "description": [ + "{@link LoggingServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LoggingServiceSetup", + "text": "LoggingServiceSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 487 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.metrics", + "type": "Object", + "tags": [], + "label": "metrics", + "description": [ + "{@link MetricsServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 489 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.savedObjects", + "type": "Object", + "tags": [], + "label": "savedObjects", + "description": [ + "{@link SavedObjectsServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceSetup", + "text": "SavedObjectsServiceSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 491 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.status", + "type": "Object", + "tags": [], + "label": "status", + "description": [ + "{@link StatusServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.StatusServiceSetup", + "text": "StatusServiceSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 493 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.uiSettings", + "type": "Object", + "tags": [], + "label": "uiSettings", + "description": [ + "{@link UiSettingsServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsServiceSetup", + "text": "UiSettingsServiceSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 495 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.deprecations", + "type": "Object", + "tags": [], + "label": "deprecations", + "description": [ + "{@link DeprecationsServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsServiceSetup", + "text": "DeprecationsServiceSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 497 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.getStartServices", + "type": "Function", + "tags": [], + "label": "getStartServices", + "description": [ + "{@link StartServicesAccessor}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.StartServicesAccessor", + "text": "StartServicesAccessor" + }, + "" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 499 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreStart", + "type": "Interface", + "tags": [], + "label": "CoreStart", + "description": [ + "\nContext passed to the plugins `start` method.\n" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 520 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CoreStart.capabilities", + "type": "Object", + "tags": [], + "label": "capabilities", + "description": [ + "{@link CapabilitiesStart}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesStart", + "text": "CapabilitiesStart" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 522 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreStart.elasticsearch", + "type": "Object", + "tags": [], + "label": "elasticsearch", + "description": [ + "{@link ElasticsearchServiceStart}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchServiceStart", + "text": "ElasticsearchServiceStart" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 524 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreStart.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [ + "{@link HttpServiceStart}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpServiceStart", + "text": "HttpServiceStart" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 526 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreStart.metrics", + "type": "Object", + "tags": [], + "label": "metrics", + "description": [ + "{@link MetricsServiceStart}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 528 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreStart.savedObjects", + "type": "Object", + "tags": [], + "label": "savedObjects", + "description": [ + "{@link SavedObjectsServiceStart}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceStart", + "text": "SavedObjectsServiceStart" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 530 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreStart.uiSettings", + "type": "Object", + "tags": [], + "label": "uiSettings", + "description": [ + "{@link UiSettingsServiceStart}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsServiceStart", + "text": "UiSettingsServiceStart" + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 532 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreStatus", + "type": "Interface", + "tags": [], + "label": "CoreStatus", + "description": [ + "\nStatus of core services.\n" + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 114 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CoreStatus.elasticsearch", + "type": "Object", + "tags": [], + "label": "elasticsearch", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + "" + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 115 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreStatus.savedObjects", + "type": "Object", + "tags": [], + "label": "savedObjects", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + "" + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 116 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CountResponse", + "type": "Interface", + "tags": [], + "label": "CountResponse", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 71 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CountResponse._shards", + "type": "Object", + "tags": [], + "label": "_shards", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ShardsInfo", + "text": "ShardsInfo" + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 72 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CountResponse.count", + "type": "number", + "tags": [], + "label": "count", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 73 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeleteDocumentResponse", + "type": "Interface", + "tags": [], + "label": "DeleteDocumentResponse", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 124 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.DeleteDocumentResponse._shards", + "type": "Object", + "tags": [], + "label": "_shards", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ShardsResponse", + "text": "ShardsResponse" + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 125 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeleteDocumentResponse.found", + "type": "boolean", + "tags": [], + "label": "found", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 126 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeleteDocumentResponse._index", + "type": "string", + "tags": [], + "label": "_index", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 127 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeleteDocumentResponse._type", + "type": "string", + "tags": [], + "label": "_type", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 128 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeleteDocumentResponse._id", + "type": "string", + "tags": [], + "label": "_id", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 129 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeleteDocumentResponse._version", + "type": "number", + "tags": [], + "label": "_version", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 130 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeleteDocumentResponse.result", + "type": "string", + "tags": [], + "label": "result", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 131 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeleteDocumentResponse.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "{ type: string; } | undefined" ], - "description": [ - "\nCreates a new {@link IContextContainer} for a service owner." + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 132 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationAPIClientParams", + "type": "Interface", + "tags": [ + "deprecated" + ], + "label": "DeprecationAPIClientParams", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationAPIClientParams", + "text": "DeprecationAPIClientParams" + }, + " extends ", + "GenericParams" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 349 + }, + "deprecated": true, + "references": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.DeprecationAPIClientParams.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "\"/_migration/deprecations\"" ], - "children": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 350 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationAPIClientParams.method", + "type": "string", "tags": [], - "returnComment": [], + "label": "method", + "description": [], + "signature": [ + "\"GET\"" + ], "source": { - "path": "src/core/server/context/context_service.ts", - "lineNumber": 96 - } + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 351 + }, + "deprecated": false } ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationAPIResponse", + "type": "Interface", + "tags": [ + "deprecated" + ], + "label": "DeprecationAPIResponse", + "description": [], "source": { - "path": "src/core/server/context/context_service.ts", - "lineNumber": 92 + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 377 + }, + "deprecated": true, + "references": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.DeprecationAPIResponse.cluster_settings", + "type": "Array", + "tags": [], + "label": "cluster_settings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationInfo", + "text": "DeprecationInfo" + }, + "[]" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 378 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationAPIResponse.ml_settings", + "type": "Array", + "tags": [], + "label": "ml_settings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationInfo", + "text": "DeprecationInfo" + }, + "[]" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 379 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationAPIResponse.node_settings", + "type": "Array", + "tags": [], + "label": "node_settings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationInfo", + "text": "DeprecationInfo" + }, + "[]" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 380 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationAPIResponse.index_settings", + "type": "Object", + "tags": [], + "label": "index_settings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IndexSettingsDeprecationInfo", + "text": "IndexSettingsDeprecationInfo" + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 381 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationInfo", + "type": "Interface", + "tags": [ + "deprecated" + ], + "label": "DeprecationInfo", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 358 }, + "deprecated": true, + "references": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.DeprecationInfo.level", + "type": "CompoundType", + "tags": [], + "label": "level", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MIGRATION_DEPRECATION_LEVEL", + "text": "MIGRATION_DEPRECATION_LEVEL" + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 359 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationInfo.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 360 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationInfo.url", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 361 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationInfo.details", + "type": "string", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 362 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { - "id": "def-server.CoreSetup", + "parentPluginId": "core", + "id": "def-server.DeprecationsDetails", "type": "Interface", - "label": "CoreSetup", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "" - ], - "description": [ - "\nContext passed to the plugins `setup` method.\n" - ], - "tags": [ - "public" - ], + "tags": [], + "label": "DeprecationsDetails", + "description": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.DeprecationsDetails.message", + "type": "string", "tags": [], - "id": "def-server.CoreSetup.capabilities", - "type": "Object", - "label": "capabilities", - "description": [ - "{@link CapabilitiesSetup}" - ], + "label": "message", + "description": [], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 466 + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 20 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSetup", - "text": "CapabilitiesSetup" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.DeprecationsDetails.level", + "type": "CompoundType", "tags": [], - "id": "def-server.CoreSetup.context", - "type": "Object", - "label": "context", + "label": "level", "description": [ - "{@link ContextSetup}" + "\nlevels:\n- warning: will not break deployment upon upgrade\n- critical: needs to be addressed before upgrade.\n- fetch_error: Deprecations service failed to grab the deprecation details for the domain." + ], + "signature": [ + "\"warning\" | \"critical\" | \"fetch_error\"" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 468 + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 27 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ContextSetup", - "text": "ContextSetup" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.DeprecationsDetails.documentationUrl", + "type": "string", "tags": [], - "id": "def-server.CoreSetup.elasticsearch", - "type": "Object", - "label": "elasticsearch", - "description": [ - "{@link ElasticsearchServiceSetup}" + "label": "documentationUrl", + "description": [], + "signature": [ + "string | undefined" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 470 + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 29 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceSetup", - "text": "ElasticsearchServiceSetup" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.DeprecationsDetails.correctiveActions", + "type": "Object", "tags": [], - "id": "def-server.CoreSetup.http", - "type": "CompoundType", - "label": "http", - "description": [ - "{@link HttpServiceSetup}" + "label": "correctiveActions", + "description": [], + "signature": [ + "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; } | undefined; manualSteps?: string[] | undefined; }" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 472 + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 31 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceSetup", - "text": "HttpServiceSetup" - }, - " & { resources: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResources", - "text": "HttpResources" - }, - "; }" - ] - }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationSettings", + "type": "Interface", + "tags": [], + "label": "DeprecationSettings", + "description": [ + "\nUiSettings deprecation field options." + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 32 + }, + "deprecated": false, + "children": [ { + "parentPluginId": "core", + "id": "def-server.DeprecationSettings.message", + "type": "string", "tags": [], - "id": "def-server.CoreSetup.i18n", - "type": "Object", - "label": "i18n", + "label": "message", "description": [ - "{@link I18nServiceSetup}" + "Deprecation message" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 477 + "path": "src/core/types/ui_settings.ts", + "lineNumber": 34 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.I18nServiceSetup", - "text": "I18nServiceSetup" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.DeprecationSettings.docLinksKey", + "type": "string", "tags": [], - "id": "def-server.CoreSetup.logging", - "type": "Object", - "label": "logging", + "label": "docLinksKey", "description": [ - "{@link LoggingServiceSetup}" + "Key to documentation links" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 479 + "path": "src/core/types/ui_settings.ts", + "lineNumber": 36 }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationsServiceSetup", + "type": "Interface", + "tags": [ + "gmail" + ], + "label": "DeprecationsServiceSetup", + "description": [ + "\nThe deprecations service provides a way for the Kibana platform to communicate deprecated\nfeatures and configs with its users. These deprecations are only communicated\nif the deployment is using these features. Allowing for a user tailored experience\nfor upgrading the stack version.\n\nThe Deprecation service is consumed by the upgrade assistant to assist with the upgrade\nexperience.\n\nIf a deprecated feature can be resolved without manual user intervention.\nUsing correctiveActions.api allows the Upgrade Assistant to use this api to correct the\ndeprecation upon a user trigger.\n" + ], + "source": { + "path": "src/core/server/deprecations/deprecations_service.ts", + "lineNumber": 103 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.DeprecationsServiceSetup.registerDeprecations", + "type": "Function", + "tags": [], + "label": "registerDeprecations", + "description": [], "signature": [ + "(deprecationContext: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LoggingServiceSetup", - "text": "LoggingServiceSetup" - } - ] - }, - { - "tags": [], - "id": "def-server.CoreSetup.metrics", - "type": "Object", - "label": "metrics", - "description": [ - "{@link MetricsServiceSetup}" + "section": "def-server.RegisterDeprecationsConfig", + "text": "RegisterDeprecationsConfig" + }, + ") => void" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 481 + "path": "src/core/server/deprecations/deprecations_service.ts", + "lineNumber": 104 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } - ] - }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "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." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 218 + }, + "deprecated": false, + "children": [ { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.id", + "type": "string", "tags": [], - "id": "def-server.CoreSetup.savedObjects", - "type": "Object", - "label": "savedObjects", + "label": "id", "description": [ - "{@link SavedObjectsServiceSetup}" + "\nIdentifier of the plugin." ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 483 + "path": "src/core/server/plugins/types.ts", + "lineNumber": 222 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsServiceSetup", - "text": "SavedObjectsServiceSetup" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.configPath", + "type": "CompoundType", "tags": [], - "id": "def-server.CoreSetup.status", - "type": "Object", - "label": "status", + "label": "configPath", "description": [ - "{@link StatusServiceSetup}" + "\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." + ], + "signature": [ + "string | string[]" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 485 + "path": "src/core/server/plugins/types.ts", + "lineNumber": 227 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.StatusServiceSetup", - "text": "StatusServiceSetup" - } - ] + "deprecated": false }, { - "tags": [], - "id": "def-server.CoreSetup.uiSettings", + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.requiredPlugins", "type": "Object", - "label": "uiSettings", + "tags": [], + "label": "requiredPlugins", "description": [ - "{@link UiSettingsServiceSetup}" + "\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly." + ], + "signature": [ + "readonly string[]" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 487 + "path": "src/core/server/plugins/types.ts", + "lineNumber": 233 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceSetup", - "text": "UiSettingsServiceSetup" - } - ] + "deprecated": false }, { - "tags": [], - "id": "def-server.CoreSetup.deprecations", + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.optionalPlugins", "type": "Object", - "label": "deprecations", + "tags": [], + "label": "optionalPlugins", "description": [ - "{@link DeprecationsServiceSetup}" + "\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[]" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 489 + "path": "src/core/server/plugins/types.ts", + "lineNumber": 240 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsServiceSetup", - "text": "DeprecationsServiceSetup" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.requiredBundles", + "type": "Object", "tags": [], - "id": "def-server.CoreSetup.getStartServices", - "type": "Function", - "label": "getStartServices", + "label": "requiredBundles", "description": [ - "{@link StartServicesAccessor}" + "\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n" + ], + "signature": [ + "readonly string[]" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 491 + "path": "src/core/server/plugins/types.ts", + "lineNumber": 252 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.StartServicesAccessor", - "text": "StartServicesAccessor" - }, - "" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 464 - }, "initialIsOpen": false }, { - "id": "def-server.CoreStart", + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup", "type": "Interface", - "label": "CoreStart", - "description": [ - "\nContext passed to the plugins `start` method.\n" - ], - "tags": [ - "public" - ], + "tags": [], + "label": "ElasticsearchServiceSetup", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-server.CoreStart.capabilities", + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup.legacy", "type": "Object", - "label": "capabilities", - "description": [ - "{@link CapabilitiesStart}" + "tags": [ + "deprecated" ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 514 - }, + "label": "legacy", + "description": [], "signature": [ + "{ readonly config$: ", + "Observable", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesStart", - "text": "CapabilitiesStart" - } - ] - }, - { - "tags": [], - "id": "def-server.CoreStart.elasticsearch", - "type": "Object", - "label": "elasticsearch", - "description": [ - "{@link ElasticsearchServiceStart}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 516 - }, - "signature": [ + "section": "def-server.ElasticsearchConfig", + "text": "ElasticsearchConfig" + }, + ">; readonly createClient: (type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceStart", - "text": "ElasticsearchServiceStart" - } - ] - }, - { - "tags": [], - "id": "def-server.CoreStart.http", - "type": "Object", - "label": "http", - "description": [ - "{@link HttpServiceStart}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 518 - }, - "signature": [ + "section": "def-server.LegacyElasticsearchClientConfig", + "text": "LegacyElasticsearchClientConfig" + }, + "> | undefined) => Pick<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceStart", - "text": "HttpServiceStart" + "docId": "kibCorePluginApi", + "section": "def-server.LegacyClusterClient", + "text": "LegacyClusterClient" + }, + ", \"close\" | \"callAsInternalUser\" | \"asScoped\">; readonly client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyClusterClient", + "text": "LegacyClusterClient" } - ] - }, - { - "tags": [], - "id": "def-server.CoreStart.metrics", - "type": "Object", - "label": "metrics", - "description": [ - "{@link MetricsServiceStart}" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 520 + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 30 }, - "signature": [ + "deprecated": true, + "references": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts", + "lineNumber": 64 + } + }, + { + "plugin": "console", + "link": { + "path": "src/plugins/console/server/plugin.ts", + "lineNumber": 42 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/plugin.ts", + "lineNumber": 94 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/plugin.ts", + "lineNumber": 105 + } } ] - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart", + "type": "Interface", + "tags": [], + "label": "ElasticsearchServiceStart", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 87 + }, + "deprecated": false, + "children": [ { - "tags": [], - "id": "def-server.CoreStart.savedObjects", + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.client", "type": "Object", - "label": "savedObjects", - "description": [ - "{@link SavedObjectsServiceStart}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 522 - }, + "tags": [], + "label": "client", + "description": [ + "\nA pre-configured {@link IClusterClient | Elasticsearch client}\n" + ], "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsServiceStart", - "text": "SavedObjectsServiceStart" + "docId": "kibCorePluginApi", + "section": "def-server.IClusterClient", + "text": "IClusterClient" } - ] + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 96 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.createClient", + "type": "Function", "tags": [], - "id": "def-server.CoreStart.uiSettings", - "type": "Object", - "label": "uiSettings", + "label": "createClient", "description": [ - "{@link UiSettingsServiceStart}" + "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 524 - }, "signature": [ + "(type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceStart", - "text": "UiSettingsServiceStart" + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" + }, + "> | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ICustomClusterClient", + "text": "ICustomClusterClient" } - ] - } - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 512 - }, - "initialIsOpen": false - }, - { - "id": "def-server.CoreStatus", - "type": "Interface", - "label": "CoreStatus", - "description": [ - "\nStatus of core services.\n" - ], - "tags": [ - "public" - ], - "children": [ + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 114 + }, + "deprecated": false + }, { - "tags": [], - "id": "def-server.CoreStatus.elasticsearch", + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.legacy", "type": "Object", - "label": "elasticsearch", + "tags": [ + "deprecated" + ], + "label": "legacy", "description": [], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 115 - }, "signature": [ + "{ readonly config$: ", + "Observable", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" + "section": "def-server.ElasticsearchConfig", + "text": "ElasticsearchConfig" }, - "" - ] - }, - { - "tags": [], - "id": "def-server.CoreStatus.savedObjects", - "type": "Object", - "label": "savedObjects", - "description": [], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 116 - }, - "signature": [ + ">; readonly createClient: (type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" + "section": "def-server.LegacyElasticsearchClientConfig", + "text": "LegacyElasticsearchClientConfig" }, - "" - ] - } - ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 114 - }, - "initialIsOpen": false - }, - { - "id": "def-server.CountResponse", - "type": "Interface", - "label": "CountResponse", - "description": [], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "id": "def-server.CountResponse._shards", - "type": "Object", - "label": "_shards", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 72 - }, - "signature": [ + "> | undefined) => Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ShardsInfo", - "text": "ShardsInfo" + "section": "def-server.LegacyClusterClient", + "text": "LegacyClusterClient" + }, + ", \"close\" | \"callAsInternalUser\" | \"asScoped\">; readonly client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyClusterClient", + "text": "LegacyClusterClient" } - ] - }, - { - "tags": [], - "id": "def-server.CountResponse.count", - "type": "number", - "label": "count", - "description": [], + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 73 - } + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 124 + }, + "deprecated": true, + "references": [ + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 105 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 117 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts", + "lineNumber": 125 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts", + "lineNumber": 218 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts", + "lineNumber": 235 + } + }, + { + "plugin": "beatsManagement", + "link": { + "path": "x-pack/plugins/beats_management/server/lib/adapters/database/kibana_database_adapter.ts", + "lineNumber": 31 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/plugin.ts", + "lineNumber": 34 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts", + "lineNumber": 33 + } + }, + { + "plugin": "globalSearch", + "link": { + "path": "x-pack/plugins/global_search/server/services/context.ts", + "lineNumber": 29 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 41 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 42 + } + }, + { + "plugin": "globalSearch", + "link": { + "path": "x-pack/plugins/global_search/server/services/context.test.ts", + "lineNumber": 24 + } + }, + { + "plugin": "globalSearch", + "link": { + "path": "x-pack/plugins/global_search/server/services/context.test.ts", + "lineNumber": 25 + } + } + ] } ], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 71 - }, "initialIsOpen": false }, { - "id": "def-server.DeleteDocumentResponse", + "parentPluginId": "core", + "id": "def-server.ElasticsearchStatusMeta", "type": "Interface", - "label": "DeleteDocumentResponse", + "tags": [], + "label": "ElasticsearchStatusMeta", "description": [], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "id": "def-server.DeleteDocumentResponse._shards", - "type": "Object", - "label": "_shards", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 125 - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ShardsResponse", - "text": "ShardsResponse" - } - ] - }, - { - "tags": [], - "id": "def-server.DeleteDocumentResponse.found", - "type": "boolean", - "label": "found", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 126 - } - }, - { - "tags": [], - "id": "def-server.DeleteDocumentResponse._index", - "type": "string", - "label": "_index", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 127 - } - }, + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 171 + }, + "deprecated": false, + "children": [ { + "parentPluginId": "core", + "id": "def-server.ElasticsearchStatusMeta.warningNodes", + "type": "Array", "tags": [], - "id": "def-server.DeleteDocumentResponse._type", - "type": "string", - "label": "_type", + "label": "warningNodes", "description": [], + "signature": [ + "NodeInfo[]" + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 128 - } + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 172 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.ElasticsearchStatusMeta.incompatibleNodes", + "type": "Array", "tags": [], - "id": "def-server.DeleteDocumentResponse._id", - "type": "string", - "label": "_id", + "label": "incompatibleNodes", "description": [], + "signature": [ + "NodeInfo[]" + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 129 - } - }, + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 173 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode", + "type": "Interface", + "tags": [], + "label": "EnvironmentMode", + "description": [], + "signature": [ + "EnvironmentMode" + ], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 14 + }, + "deprecated": false, + "children": [ { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.name", + "type": "CompoundType", "tags": [], - "id": "def-server.DeleteDocumentResponse._version", - "type": "number", - "label": "_version", + "label": "name", "description": [], + "signature": [ + "\"production\" | \"development\"" + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 130 - } + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 15 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.dev", + "type": "boolean", "tags": [], - "id": "def-server.DeleteDocumentResponse.result", - "type": "string", - "label": "result", + "label": "dev", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 131 - } + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 16 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.prod", + "type": "boolean", "tags": [], - "id": "def-server.DeleteDocumentResponse.error", - "type": "Object", - "label": "error", + "label": "prod", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 132 + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 17 }, - "signature": [ - "{ type: string; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 124 - }, "initialIsOpen": false }, { - "id": "def-server.DeprecationAPIClientParams", + "parentPluginId": "core", + "id": "def-server.FakeRequest", "type": "Interface", - "label": "DeprecationAPIClientParams", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationAPIClientParams", - "text": "DeprecationAPIClientParams" - }, - " extends ", - "GenericParams" - ], - "description": [], - "tags": [ - "deprecated", - "public" + "tags": [], + "label": "FakeRequest", + "description": [ + "\nFake request object created manually by Kibana plugins." ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 180 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.FakeRequest.headers", + "type": "CompoundType", "tags": [], - "id": "def-server.DeprecationAPIClientParams.path", - "type": "string", - "label": "path", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 350 - }, + "label": "headers", + "description": [ + "Headers used for authentication against Elasticsearch" + ], "signature": [ - "\"/_migration/deprecations\"" - ] - }, - { - "tags": [], - "id": "def-server.DeprecationAPIClientParams.method", - "type": "string", - "label": "method", - "description": [], + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Headers", + "text": "Headers" + } + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 351 + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 182 }, - "signature": [ - "\"GET\"" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 349 - }, "initialIsOpen": false }, { - "id": "def-server.DeprecationAPIResponse", + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext", "type": "Interface", - "label": "DeprecationAPIResponse", + "tags": [], + "label": "GetDeprecationsContext", "description": [], - "tags": [ - "deprecated", - "public" - ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext.esClient", + "type": "Object", "tags": [], - "id": "def-server.DeprecationAPIResponse.cluster_settings", - "type": "Array", - "label": "cluster_settings", + "label": "esClient", "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 378 - }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.DeprecationInfo", - "text": "DeprecationInfo" - }, - "[]" - ] - }, - { - "tags": [], - "id": "def-server.DeprecationAPIResponse.ml_settings", - "type": "Array", - "label": "ml_settings", - "description": [], + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 379 + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 61 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationInfo", - "text": "DeprecationInfo" - }, - "[]" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext.savedObjectsClient", + "type": "Object", "tags": [], - "id": "def-server.DeprecationAPIResponse.node_settings", - "type": "Array", - "label": "node_settings", + "label": "savedObjectsClient", "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 380 - }, "signature": [ + "Pick<", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationInfo", - "text": "DeprecationInfo" + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" }, - "[]" - ] - }, - { - "tags": [], - "id": "def-server.DeprecationAPIResponse.index_settings", - "type": "Object", - "label": "index_settings", - "description": [], + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 381 - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IndexSettingsDeprecationInfo", - "text": "IndexSettingsDeprecationInfo" - } - ] + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 62 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 377 - }, "initialIsOpen": false }, { - "id": "def-server.DeprecationInfo", + "parentPluginId": "core", + "id": "def-server.GetResponse", "type": "Interface", - "label": "DeprecationInfo", + "tags": [], + "label": "GetResponse", "description": [], - "tags": [ - "deprecated", - "public" + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.GetResponse", + "text": "GetResponse" + }, + "" ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 109 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.GetResponse._index", + "type": "string", "tags": [], - "id": "def-server.DeprecationInfo.level", - "type": "CompoundType", - "label": "level", + "label": "_index", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 359 + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 110 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MIGRATION_DEPRECATION_LEVEL", - "text": "MIGRATION_DEPRECATION_LEVEL" - } - ] + "deprecated": false }, { - "tags": [], - "id": "def-server.DeprecationInfo.message", + "parentPluginId": "core", + "id": "def-server.GetResponse._type", "type": "string", - "label": "message", + "tags": [], + "label": "_type", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 360 - } + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 111 + }, + "deprecated": false }, { - "tags": [], - "id": "def-server.DeprecationInfo.url", + "parentPluginId": "core", + "id": "def-server.GetResponse._id", "type": "string", - "label": "url", + "tags": [], + "label": "_id", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 361 - } + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 112 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetResponse._version", + "type": "number", "tags": [], - "id": "def-server.DeprecationInfo.details", - "type": "string", - "label": "details", + "label": "_version", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 362 + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 113 }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetResponse._routing", + "type": "string", + "tags": [], + "label": "_routing", + "description": [], "signature": [ "string | undefined" - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 358 - }, - "initialIsOpen": false - }, - { - "id": "def-server.DeprecationsDetails", - "type": "Interface", - "label": "DeprecationsDetails", - "description": [], - "tags": [], - "children": [ + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 114 + }, + "deprecated": false + }, { + "parentPluginId": "core", + "id": "def-server.GetResponse.found", + "type": "boolean", "tags": [], - "id": "def-server.DeprecationsDetails.message", - "type": "string", - "label": "message", + "label": "found", "description": [], "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 20 - } + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 115 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetResponse._source", + "type": "Uncategorized", "tags": [], - "id": "def-server.DeprecationsDetails.level", - "type": "CompoundType", - "label": "level", - "description": [ - "\nlevels:\n- warning: will not break deployment upon upgrade\n- critical: needs to be addressed before upgrade.\n- fetch_error: Deprecations service failed to grab the deprecation details for the domain." + "label": "_source", + "description": [], + "signature": [ + "T" ], "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 27 + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 116 }, - "signature": [ - "\"warning\" | \"critical\" | \"fetch_error\"" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetResponse._seq_no", + "type": "number", "tags": [], - "id": "def-server.DeprecationsDetails.documentationUrl", - "type": "string", - "label": "documentationUrl", + "label": "_seq_no", "description": [], "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 29 + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 117 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetResponse._primary_term", + "type": "number", "tags": [], - "id": "def-server.DeprecationsDetails.correctiveActions", - "type": "Object", - "label": "correctiveActions", + "label": "_primary_term", "description": [], "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 31 + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 118 }, - "signature": [ - "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; } | undefined; manualSteps?: string[] | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { - "id": "def-server.DeprecationSettings", + "parentPluginId": "core", + "id": "def-server.HttpResources", "type": "Interface", - "label": "DeprecationSettings", + "tags": [], + "label": "HttpResources", "description": [ - "\nUiSettings deprecation field options." - ], - "tags": [ - "public" + "\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file." ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 99 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.HttpResources.register", + "type": "Function", "tags": [], - "id": "def-server.DeprecationSettings.message", - "type": "string", - "label": "message", + "label": "register", "description": [ - "Deprecation message" + "To register a route handler executing passed function to form response." + ], + "signature": [ + "(route: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream" ], "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 34 - } - }, + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 101 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRenderOptions", + "type": "Interface", + "tags": [], + "label": "HttpResourcesRenderOptions", + "description": [ + "\nAllows to configure HTTP response parameters" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 24 + }, + "deprecated": false, + "children": [ { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRenderOptions.headers", + "type": "CompoundType", "tags": [], - "id": "def-server.DeprecationSettings.docLinksKey", - "type": "string", - "label": "docLinksKey", + "label": "headers", "description": [ - "Key to documentation links" + "\nHTTP Headers with additional information about response." + ], + "signature": [ + "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" ], "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 36 - } + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 30 + }, + "deprecated": false } ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 32 - }, "initialIsOpen": false }, { - "id": "def-server.DeprecationsServiceSetup", + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit", "type": "Interface", - "label": "DeprecationsServiceSetup", + "tags": [], + "label": "HttpResourcesServiceToolkit", "description": [ - "\nThe deprecations service provides a way for the Kibana platform to communicate deprecated\nfeatures and configs with its users. These deprecations are only communicated\nif the deployment is using these features. Allowing for a user tailored experience\nfor upgrading the stack version.\n\nThe Deprecation service is consumed by the upgrade assistant to assist with the upgrade\nexperience.\n\nIf a deprecated feature can be resolved without manual user intervention.\nUsing correctiveActions.api allows the Upgrade Assistant to use this api to correct the\ndeprecation upon a user trigger.\n" - ], - "tags": [ - "gmail", - "public" + "\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource." ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-server.DeprecationsServiceSetup.registerDeprecations", + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", "type": "Function", - "label": "registerDeprecations", - "description": [], - "source": { - "path": "src/core/server/deprecations/deprecations_service.ts", - "lineNumber": 104 - }, + "tags": [], + "label": "renderCoreApp", + "description": [ + "To respond with HTML page bootstrapping Kibana application." + ], "signature": [ - "(deprecationContext: ", + "(options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.RegisterDeprecationsConfig", - "text": "RegisterDeprecationsConfig" + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" }, - ") => void" - ] - } - ], - "source": { - "path": "src/core/server/deprecations/deprecations_service.ts", - "lineNumber": 103 - }, - "initialIsOpen": false - }, - { - "id": "def-server.DiscoveredPlugin", - "type": "Interface", - "label": "DiscoveredPlugin", - "description": [ - "\nSmall container object used to expose information about discovered plugins that may\nor may not have been started." - ], - "tags": [ - "public" - ], - "children": [ + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 45 + }, + "deprecated": false + }, { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp", + "type": "Function", "tags": [], - "id": "def-server.DiscoveredPlugin.id", - "type": "string", - "label": "id", + "label": "renderAnonymousCoreApp", "description": [ - "\nIdentifier of the plugin." + "To respond with HTML page bootstrapping Kibana application without retrieving user-specific information." + ], + "signature": [ + "(options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" ], "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 189 - } + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 47 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderHtml", + "type": "Function", "tags": [], - "id": "def-server.DiscoveredPlugin.configPath", - "type": "CompoundType", - "label": "configPath", + "label": "renderHtml", "description": [ - "\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." + "To respond with a custom HTML page." + ], + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" ], "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 194 + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 49 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderJs", + "type": "Function", "tags": [], - "id": "def-server.DiscoveredPlugin.requiredPlugins", - "type": "Object", - "label": "requiredPlugins", + "label": "renderJs", "description": [ - "\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly." + "To respond with a custom JS script file." + ], + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" ], "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 200 + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 51 }, - "signature": [ - "readonly string[]" - ] - }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.I18nServiceSetup", + "type": "Interface", + "tags": [], + "label": "I18nServiceSetup", + "description": [], + "source": { + "path": "src/core/server/i18n/i18n_service.ts", + "lineNumber": 27 + }, + "deprecated": false, + "children": [ { + "parentPluginId": "core", + "id": "def-server.I18nServiceSetup.getLocale", + "type": "Function", "tags": [], - "id": "def-server.DiscoveredPlugin.optionalPlugins", - "type": "Object", - "label": "optionalPlugins", + "label": "getLocale", "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." + "\nReturn the locale currently in use." + ], + "signature": [ + "() => string" ], "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 207 + "path": "src/core/server/i18n/i18n_service.ts", + "lineNumber": 31 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", + "id": "def-server.I18nServiceSetup.getTranslationFiles", + "type": "Function", "tags": [], - "id": "def-server.DiscoveredPlugin.requiredBundles", - "type": "Object", - "label": "requiredBundles", + "label": "getTranslationFiles", "description": [ - "\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n" + "\nReturn the absolute paths to translation files currently in use." + ], + "signature": [ + "() => string[]" ], "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 219 + "path": "src/core/server/i18n/i18n_service.ts", + "lineNumber": 36 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 185 - }, "initialIsOpen": false }, { - "id": "def-server.ElasticsearchServiceSetup", + "parentPluginId": "core", + "id": "def-server.IClusterClient", "type": "Interface", - "label": "ElasticsearchServiceSetup", - "description": [], - "tags": [ - "public" + "tags": [], + "label": "IClusterClient", + "description": [ + "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n" ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ - { - "tags": [ - "deprecated" + { + "parentPluginId": "core", + "id": "def-server.IClusterClient.asInternalUser", + "type": "CompoundType", + "tags": [], + "label": "asInternalUser", + "description": [ + "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" ], - "id": "def-server.ElasticsearchServiceSetup.legacy", - "type": "Object", - "label": "legacy", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 30 - }, "signature": [ - "{ readonly config$: ", - "Observable", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchConfig", - "text": "ElasticsearchConfig" - }, - ">; readonly createClient: (type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyElasticsearchClientConfig", - "text": "LegacyElasticsearchClientConfig" - }, - "> | undefined) => Pick<", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 33 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IClusterClient.asScoped", + "type": "Function", + "tags": [], + "label": "asScoped", + "description": [ + "\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}" + ], + "signature": [ + "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyClusterClient", - "text": "LegacyClusterClient" + "section": "def-server.ScopeableRequest", + "text": "ScopeableRequest" }, - ", \"close\" | \"callAsInternalUser\" | \"asScoped\">; readonly client: Pick<", + ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyClusterClient", - "text": "LegacyClusterClient" + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" } - ] + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 37 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { - "id": "def-server.ElasticsearchServiceStart", + "parentPluginId": "core", + "id": "def-server.IContextContainer", "type": "Interface", - "label": "ElasticsearchServiceStart", - "description": [], - "tags": [ - "public" + "tags": [], + "label": "IContextContainer", + "description": [ + "\nAn object that handles registration of context providers and configuring handlers with context.\n" ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 135 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext", + "type": "Function", "tags": [], - "id": "def-server.ElasticsearchServiceStart.client", - "type": "Object", - "label": "client", + "label": "registerContext", "description": [ - "\nA pre-configured {@link IClusterClient | Elasticsearch client}\n" + "\nRegister a new context provider.\n" ], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 96 - }, "signature": [ + "(pluginOpaqueId: symbol, contextName: ContextName, provider: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClientConfig", - "text": "ElasticsearchClientConfig" + "section": "def-server.IContextProvider", + "text": "IContextProvider" }, - "> | undefined) => ", + ") => this" + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 150 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext.$1", + "type": "Uncategorized", + "tags": [], + "label": "pluginOpaqueId", + "description": [ + "- The plugin opaque ID for the plugin that registers this context." + ], + "signature": [ + "symbol" + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 151 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext.$2", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [ + "- The key of the `TContext` object this provider supplies the value for." + ], + "signature": [ + "ContextName" + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 152 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext.$3", + "type": "Function", + "tags": [], + "label": "provider", + "description": [ + "- A {@link IContextProvider} to be called each time a new context is created." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + "" + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 153 + }, + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "The {@link IContextContainer} for method chaining." ] }, { - "tags": [ - "deprecated" + "parentPluginId": "core", + "id": "def-server.IContextContainer.createHandler", + "type": "Function", + "tags": [], + "label": "createHandler", + "description": [ + "\nCreate a new handler function pre-wired to context for the plugin.\n" ], - "id": "def-server.ElasticsearchServiceStart.legacy", - "type": "Object", - "label": "legacy", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 124 - }, "signature": [ - "{ readonly config$: ", - "Observable", - "<", + "(pluginOpaqueId: symbol, handler: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchConfig", - "text": "ElasticsearchConfig" + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" }, - ">; readonly createClient: (type: string, clientConfig?: Partial<", + " | undefined) => Pick<", + ", any, { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyClusterClient", - "text": "LegacyClusterClient" + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" }, - ", \"close\" | \"callAsInternalUser\" | \"asScoped\">; readonly client: Pick<", + ") => ", + "KibanaResponse" + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 164 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyClusterClient", - "text": "LegacyClusterClient" + "parentPluginId": "core", + "id": "def-server.IContextContainer.createHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "pluginOpaqueId", + "description": [ + "- The plugin opaque ID for the plugin that registers this handler." + ], + "signature": [ + "symbol" + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 165 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.createHandler.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "- Handler function to pass context object to." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse" + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 166 + }, + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of\nthe `handler` return value." ] } ], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 87 - }, "initialIsOpen": false }, { - "id": "def-server.ElasticsearchStatusMeta", + "parentPluginId": "core", + "id": "def-server.ICspConfig", "type": "Interface", - "label": "ElasticsearchStatusMeta", - "description": [], - "tags": [ - "public" + "tags": [], + "label": "ICspConfig", + "description": [ + "\nCSP configuration for use in Kibana." ], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-server.ElasticsearchStatusMeta.warningNodes", + "parentPluginId": "core", + "id": "def-server.ICspConfig.rules", "type": "Array", - "label": "warningNodes", - "description": [], + "tags": [], + "label": "rules", + "description": [ + "\nThe CSP rules used for Kibana." + ], + "signature": [ + "string[]" + ], "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 172 + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 21 }, - "signature": [ - "NodeInfo[]" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.ICspConfig.strict", + "type": "boolean", "tags": [], - "id": "def-server.ElasticsearchStatusMeta.incompatibleNodes", - "type": "Array", - "label": "incompatibleNodes", - "description": [], + "label": "strict", + "description": [ + "\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow." + ], "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 173 + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 27 }, - "signature": [ - "NodeInfo[]" - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 171 - }, - "initialIsOpen": false - }, - { - "id": "def-server.EnvironmentMode", - "type": "Interface", - "label": "EnvironmentMode", - "signature": [ - "EnvironmentMode" - ], - "description": [], - "tags": [ - "public" - ], - "children": [ + "deprecated": false + }, { + "parentPluginId": "core", + "id": "def-server.ICspConfig.warnLegacyBrowsers", + "type": "boolean", "tags": [], - "id": "def-server.EnvironmentMode.name", - "type": "CompoundType", - "label": "name", - "description": [], + "label": "warnLegacyBrowsers", + "description": [ + "\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance." + ], "source": { - "path": "node_modules/@kbn/config/target/types.d.ts", - "lineNumber": 15 + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 33 }, - "signature": [ - "\"production\" | \"development\"" - ] + "deprecated": false }, { - "tags": [], - "id": "def-server.EnvironmentMode.dev", + "parentPluginId": "core", + "id": "def-server.ICspConfig.disableEmbedding", "type": "boolean", - "label": "dev", - "description": [], + "tags": [], + "label": "disableEmbedding", + "description": [ + "\nWhether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled *and* no custom rules have been\ndefined, a restrictive 'frame-ancestors' rule will be added to the default CSP rules." + ], "source": { - "path": "node_modules/@kbn/config/target/types.d.ts", - "lineNumber": 16 - } + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 39 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.ICspConfig.header", + "type": "string", "tags": [], - "id": "def-server.EnvironmentMode.prod", - "type": "boolean", - "label": "prod", - "description": [], + "label": "header", + "description": [ + "\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header." + ], "source": { - "path": "node_modules/@kbn/config/target/types.d.ts", - "lineNumber": 17 - } + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 45 + }, + "deprecated": false } ], - "source": { - "path": "node_modules/@kbn/config/target/types.d.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { - "id": "def-server.FakeRequest", + "parentPluginId": "core", + "id": "def-server.ICustomClusterClient", "type": "Interface", - "label": "FakeRequest", + "tags": [], + "label": "ICustomClusterClient", "description": [ - "\nFake request object created manually by Kibana plugins." + "\nSee {@link IClusterClient}\n" ], - "tags": [ - "public" + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ICustomClusterClient", + "text": "ICustomClusterClient" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IClusterClient", + "text": "IClusterClient" + } ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.ICustomClusterClient.close", + "type": "Function", "tags": [], - "id": "def-server.FakeRequest.headers", - "type": "CompoundType", - "label": "headers", + "label": "close", "description": [ - "Headers used for authentication against Elasticsearch" + "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." + ], + "signature": [ + "() => Promise" ], "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 182 + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 50 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.Headers", - "text": "Headers" - } - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 180 - }, "initialIsOpen": false }, { - "id": "def-server.GetDeprecationsContext", + "parentPluginId": "core", + "id": "def-server.IExternalUrlConfig", "type": "Interface", - "label": "GetDeprecationsContext", - "description": [], "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.GetDeprecationsContext.esClient", - "type": "Object", - "label": "esClient", - "description": [], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 61 - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" - } - ] - }, + "label": "IExternalUrlConfig", + "description": [ + "\nExternal Url configuration for use in Kibana." + ], + "source": { + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 18 + }, + "deprecated": false, + "children": [ { + "parentPluginId": "core", + "id": "def-server.IExternalUrlConfig.policy", + "type": "Array", "tags": [], - "id": "def-server.GetDeprecationsContext.savedObjectsClient", - "type": "Object", - "label": "savedObjectsClient", - "description": [], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 62 - }, + "label": "policy", + "description": [ + "\nA set of policies describing which external urls are allowed." + ], "signature": [ - "Pick<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "docId": "kibCorePluginApi", + "section": "def-server.IExternalUrlPolicy", + "text": "IExternalUrlPolicy" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ] + "[]" + ], + "source": { + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 22 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 60 - }, "initialIsOpen": false }, { - "id": "def-server.GetResponse", + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy", "type": "Interface", - "label": "GetResponse", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.GetResponse", - "text": "GetResponse" - }, - "" - ], - "description": [], - "tags": [ - "public" + "tags": [], + "label": "IExternalUrlPolicy", + "description": [ + "\nA policy describing whether access to an external destination is allowed." ], + "source": { + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.allow", + "type": "boolean", "tags": [], - "id": "def-server.GetResponse._index", - "type": "string", - "label": "_index", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 110 - } - }, - { - "tags": [], - "id": "def-server.GetResponse._type", - "type": "string", - "label": "_type", - "description": [], + "label": "allow", + "description": [ + "\nIndicates if this policy allows or denies access to the described destination." + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 111 - } + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], - "id": "def-server.GetResponse._id", + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.host", "type": "string", - "label": "_id", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 112 - } - }, - { - "tags": [], - "id": "def-server.GetResponse._version", - "type": "number", - "label": "_version", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 113 - } - }, - { "tags": [], - "id": "def-server.GetResponse._routing", - "type": "string", - "label": "_routing", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 114 - }, + "label": "host", + "description": [ + "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" + ], "signature": [ "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.GetResponse.found", - "type": "boolean", - "label": "found", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 115 - } - }, - { - "tags": [], - "id": "def-server.GetResponse._source", - "type": "Uncategorized", - "label": "_source", - "description": [], + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 116 + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 46 }, - "signature": [ - "T" - ] - }, - { - "tags": [], - "id": "def-server.GetResponse._seq_no", - "type": "number", - "label": "_seq_no", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 117 - } + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.protocol", + "type": "string", "tags": [], - "id": "def-server.GetResponse._primary_term", - "type": "number", - "label": "_primary_term", - "description": [], + "label": "protocol", + "description": [ + "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" + ], + "signature": [ + "string | undefined" + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 118 - } + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 59 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 109 - }, "initialIsOpen": false }, { - "id": "def-server.HttpResources", + "parentPluginId": "core", + "id": "def-server.ImageValidation", "type": "Interface", - "label": "HttpResources", - "description": [ - "\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file." - ], - "tags": [ - "public" - ], + "tags": [], + "label": "ImageValidation", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 131 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.ImageValidation.maxSize", + "type": "Object", "tags": [], - "id": "def-server.HttpResources.register", - "type": "Function", - "label": "register", - "description": [ - "To register a route handler executing passed function to form response." + "label": "maxSize", + "description": [], + "signature": [ + "{ length: number; description: string; }" ], "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 101 + "path": "src/core/types/ui_settings.ts", + "lineNumber": 132 }, - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", - "Stream" - ] + "deprecated": false } ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IndexSettingsDeprecationInfo", + "type": "Interface", + "tags": [ + "deprecated" + ], + "label": "IndexSettingsDeprecationInfo", + "description": [], "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 99 + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 369 }, + "deprecated": true, + "references": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IndexSettingsDeprecationInfo.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 370 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { - "id": "def-server.HttpResourcesRenderOptions", + "parentPluginId": "core", + "id": "def-server.IRenderOptions", "type": "Interface", - "label": "HttpResourcesRenderOptions", - "description": [ - "\nAllows to configure HTTP response parameters" - ], - "tags": [ - "public" - ], + "tags": [], + "label": "IRenderOptions", + "description": [], + "source": { + "path": "src/core/server/rendering/types.ts", + "lineNumber": 68 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-server.HttpResourcesRenderOptions.headers", + "parentPluginId": "core", + "id": "def-server.IRenderOptions.includeUserSettings", "type": "CompoundType", - "label": "headers", + "tags": [], + "label": "includeUserSettings", "description": [ - "\nHTTP Headers with additional information about response." + "\nSet whether to output user settings in the page metadata.\n`true` by default." + ], + "signature": [ + "boolean | undefined" ], "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 30 + "path": "src/core/server/rendering/types.ts", + "lineNumber": 73 }, - "signature": [ - "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { - "id": "def-server.HttpResourcesServiceToolkit", + "parentPluginId": "core", + "id": "def-server.IScopedClusterClient", "type": "Interface", - "label": "HttpResourcesServiceToolkit", + "tags": [], + "label": "IScopedClusterClient", "description": [ - "\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource." - ], - "tags": [ - "public" + "\nServes the same purpose as the normal {@link IClusterClient | cluster client} but exposes\nan additional `asCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers\nextracted from the current user request to the API instead.\n" ], + "source": { + "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.IScopedClusterClient.asInternalUser", + "type": "CompoundType", "tags": [], - "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", - "type": "Function", - "label": "renderCoreApp", + "label": "asInternalUser", "description": [ - "To respond with HTML page bootstrapping Kibana application." + "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user." ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 45 - }, "signature": [ - "(options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ] - }, - { - "tags": [], - "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp", - "type": "Function", - "label": "renderAnonymousCoreApp", - "description": [ - "To respond with HTML page bootstrapping Kibana application without retrieving user-specific information." + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } ], "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 47 + "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", + "lineNumber": 24 }, - "signature": [ - "(options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.IScopedClusterClient.asCurrentUser", + "type": "CompoundType", "tags": [], - "id": "def-server.HttpResourcesServiceToolkit.renderHtml", - "type": "Function", - "label": "renderHtml", + "label": "asCurrentUser", "description": [ - "To respond with a custom HTML page." + "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the user that initiated the request to the Kibana server." ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 49 - }, "signature": [ - "(options: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - "" - ] - }, - { - "tags": [], - "id": "def-server.HttpResourcesServiceToolkit.renderJs", - "type": "Function", - "label": "renderJs", - "description": [ - "To respond with a custom JS script file." + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } ], "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 51 + "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", + "lineNumber": 29 }, - "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - "" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 43 - }, "initialIsOpen": false }, { - "id": "def-server.I18nServiceSetup", + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient", "type": "Interface", - "label": "I18nServiceSetup", - "description": [], - "tags": [ - "public" + "tags": [], + "label": "IUiSettingsClient", + "description": [ + "\nServer-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n" ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "id": "def-server.I18nServiceSetup.getLocale", + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.getRegistered", "type": "Function", - "label": "getLocale", + "tags": [], + "label": "getRegistered", + "description": [ + "\nReturns registered uiSettings values {@link UiSettingsParams}" + ], "signature": [ - "() => string" + "() => Readonly, \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"validation\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\">>>" ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 35 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.get", + "type": "Function", + "tags": [], + "label": "get", "description": [ - "\nReturn the locale currently in use." + "\nRetrieves uiSettings values set by the user with fallbacks to default values if not specified." + ], + "signature": [ + "(key: string) => Promise" ], - "children": [], - "tags": [], - "returnComment": [], "source": { - "path": "src/core/server/i18n/i18n_service.ts", - "lineNumber": 31 - } + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 39 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.getAll", + "type": "Function", + "tags": [], + "label": "getAll", + "description": [ + "\nRetrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified." + ], + "signature": [ + "() => Promise>" + ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 43 + }, + "deprecated": false }, { - "id": "def-server.I18nServiceSetup.getTranslationFiles", + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.getUserProvided", "type": "Function", - "label": "getTranslationFiles", - "signature": [ - "() => string[]" - ], + "tags": [], + "label": "getUserProvided", "description": [ - "\nReturn the absolute paths to translation files currently in use." + "\nRetrieves a set of all uiSettings values set by the user." + ], + "signature": [ + "() => Promise>>" ], - "children": [], - "tags": [], - "returnComment": [], "source": { - "path": "src/core/server/i18n/i18n_service.ts", - "lineNumber": 36 - } - } - ], - "source": { - "path": "src/core/server/i18n/i18n_service.ts", - "lineNumber": 27 - }, - "initialIsOpen": false - }, - { - "id": "def-server.IClusterClient", - "type": "Interface", - "label": "IClusterClient", - "description": [ - "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n" - ], - "tags": [ - "public" - ], - "children": [ + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 47 + }, + "deprecated": false + }, { + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.setMany", + "type": "Function", "tags": [], - "id": "def-server.IClusterClient.asInternalUser", - "type": "CompoundType", - "label": "asInternalUser", + "label": "setMany", "description": [ - "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" + "\nWrites multiple uiSettings values and marks them as set by the user." + ], + "signature": [ + "(changes: Record) => Promise" ], "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 33 + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 51 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } - ] + "deprecated": false }, { - "tags": [], - "id": "def-server.IClusterClient.asScoped", + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.set", "type": "Function", - "label": "asScoped", + "tags": [], + "label": "set", "description": [ - "\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}" + "\nWrites uiSettings value and marks it as set by the user." + ], + "signature": [ + "(key: string, value: any) => Promise" ], "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 37 + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 55 }, - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ScopeableRequest", - "text": "ScopeableRequest" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" - } - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 29 - }, - "initialIsOpen": false - }, - { - "id": "def-server.IContextContainer", - "type": "Interface", - "label": "IContextContainer", - "description": [ - "\nAn object that handles registration of context providers and configuring handlers with context.\n" - ], - "tags": [ - "public" - ], - "children": [ + "deprecated": false + }, { - "id": "def-server.IContextContainer.registerContext", + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.remove", "type": "Function", - "label": "registerContext", - "signature": [ - "(pluginOpaqueId: symbol, contextName: ContextName, provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextProvider", - "text": "IContextProvider" - }, - ") => this" - ], + "tags": [], + "label": "remove", "description": [ - "\nRegister a new context provider.\n" - ], - "children": [ - { - "id": "def-server.IContextContainer.registerContext.$1", - "type": "Uncategorized", - "label": "pluginOpaqueId", - "isRequired": true, - "signature": [ - "symbol" - ], - "description": [ - "- The plugin opaque ID for the plugin that registers this context." - ], - "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 151 - } - }, - { - "id": "def-server.IContextContainer.registerContext.$2", - "type": "Uncategorized", - "label": "contextName", - "isRequired": true, - "signature": [ - "ContextName" - ], - "description": [ - "- The key of the `TContext` object this provider supplies the value for." - ], - "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 152 - } - }, - { - "id": "def-server.IContextContainer.registerContext.$3", - "type": "Function", - "label": "provider", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextProvider", - "text": "IContextProvider" - }, - "" - ], - "description": [ - "- A {@link IContextProvider} to be called each time a new context is created." - ], - "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 153 - } - } + "\nRemoves uiSettings value by key." ], - "tags": [], - "returnComment": [ - "The {@link IContextContainer} for method chaining." + "signature": [ + "(key: string) => Promise" ], "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 150 - } + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 59 + }, + "deprecated": false }, { - "id": "def-server.IContextContainer.createHandler", + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.removeMany", "type": "Function", - "label": "createHandler", + "tags": [], + "label": "removeMany", + "description": [ + "\nRemoves multiple uiSettings values by keys." + ], "signature": [ - "(pluginOpaqueId: symbol, handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse" + "(keys: string[]) => Promise" ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 63 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.isOverridden", + "type": "Function", + "tags": [], + "label": "isOverridden", "description": [ - "\nCreate a new handler function pre-wired to context for the plugin.\n" + "\nShows whether the uiSettings value set by the user." ], - "children": [ - { - "id": "def-server.IContextContainer.createHandler.$1", - "type": "Uncategorized", - "label": "pluginOpaqueId", - "isRequired": true, - "signature": [ - "symbol" - ], - "description": [ - "- The plugin opaque ID for the plugin that registers this handler." - ], - "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 165 - } - }, - { - "id": "def-server.IContextContainer.createHandler.$2", - "type": "Function", - "label": "handler", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse" - ], - "description": [ - "- Handler function to pass context object to." - ], - "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 166 - } - } + "signature": [ + "(key: string) => boolean" ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 67 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.isSensitive", + "type": "Function", "tags": [], - "returnComment": [ - "A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of\nthe `handler` return value." + "label": "isSensitive", + "description": [ + "\nShows whether the uiSetting is a sensitive value. Used by telemetry to not send sensitive values." + ], + "signature": [ + "(key: string) => boolean" ], "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 164 - } + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 71 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 135 - }, "initialIsOpen": false }, { - "id": "def-server.ICspConfig", + "parentPluginId": "core", + "id": "def-server.LegacyAPICaller", "type": "Interface", - "label": "ICspConfig", - "description": [ - "\nCSP configuration for use in Kibana." - ], "tags": [ - "public" + "deprecated" ], - "children": [ + "label": "LegacyAPICaller", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 162 + }, + "deprecated": true, + "references": [ + { + "plugin": "lists", + "link": { + "path": "x-pack/plugins/lists/common/get_call_cluster.mock.ts", + "lineNumber": 9 + } + }, + { + "plugin": "lists", + "link": { + "path": "x-pack/plugins/lists/common/get_call_cluster.mock.ts", + "lineNumber": 26 + } + }, + { + "plugin": "lists", + "link": { + "path": "x-pack/plugins/lists/common/get_call_cluster.mock.ts", + "lineNumber": 30 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts", + "lineNumber": 10 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts", + "lineNumber": 447 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/telemetry/sender.ts", + "lineNumber": 466 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/lib/query_es_sql.ts", + "lineNumber": 12 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/lib/query_es_sql.ts", + "lineNumber": 37 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts", + "lineNumber": 8 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts", + "lineNumber": 40 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts", + "lineNumber": 17 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts", + "lineNumber": 36 + } + }, + { + "plugin": "indexLifecycleManagement", + "link": { + "path": "x-pack/plugins/index_lifecycle_management/server/plugin.ts", + "lineNumber": 14 + } + }, + { + "plugin": "indexLifecycleManagement", + "link": { + "path": "x-pack/plugins/index_lifecycle_management/server/plugin.ts", + "lineNumber": 29 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_es_usage.ts", + "lineNumber": 8 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_es_usage.ts", + "lineNumber": 45 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_stack_product_usage.ts", + "lineNumber": 9 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_stack_product_usage.ts", + "lineNumber": 36 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/get_stack_products_usage.ts", + "lineNumber": 8 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/get_stack_products_usage.ts", + "lineNumber": 27 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_license_type.ts", + "lineNumber": 9 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_license_type.ts", + "lineNumber": 14 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_high_level_stats.ts", + "lineNumber": 10 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_high_level_stats.ts", + "lineNumber": 251 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_high_level_stats.ts", + "lineNumber": 272 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_logstash_stats.ts", + "lineNumber": 9 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_logstash_stats.ts", + "lineNumber": 264 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_logstash_stats.ts", + "lineNumber": 328 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_logstash_stats.ts", + "lineNumber": 395 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_beats_stats.ts", + "lineNumber": 10 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_beats_stats.ts", + "lineNumber": 322 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_beats_stats.ts", + "lineNumber": 386 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_beats_stats.ts", + "lineNumber": 396 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_beats_stats.ts", + "lineNumber": 414 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_es_stats.ts", + "lineNumber": 9 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_es_stats.ts", + "lineNumber": 20 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_es_stats.ts", + "lineNumber": 38 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_kibana_stats.ts", + "lineNumber": 11 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_kibana_stats.ts", + "lineNumber": 186 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_all_stats.ts", + "lineNumber": 12 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_all_stats.ts", + "lineNumber": 31 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_cluster_uuids.ts", + "lineNumber": 10 + } + }, { - "tags": [], - "id": "def-server.ICspConfig.rules", - "type": "Array", - "label": "rules", - "description": [ - "\nThe CSP rules used for Kibana." - ], - "source": { - "path": "src/core/server/csp/csp_config.ts", + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_cluster_uuids.ts", "lineNumber": 21 - }, - "signature": [ - "string[]" - ] + } }, { - "tags": [], - "id": "def-server.ICspConfig.strict", - "type": "boolean", - "label": "strict", - "description": [ - "\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow." - ], - "source": { - "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 27 + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_cluster_uuids.ts", + "lineNumber": 33 } }, { - "tags": [], - "id": "def-server.ICspConfig.warnLegacyBrowsers", - "type": "boolean", - "label": "warnLegacyBrowsers", - "description": [ - "\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance." - ], - "source": { - "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 33 + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_licenses.ts", + "lineNumber": 9 } }, { - "tags": [], - "id": "def-server.ICspConfig.header", - "type": "string", - "label": "header", - "description": [ - "\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header." - ], - "source": { - "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 39 + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_licenses.ts", + "lineNumber": 18 } - } - ], - "source": { - "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 17 - }, - "initialIsOpen": false - }, - { - "id": "def-server.ICustomClusterClient", - "type": "Interface", - "label": "ICustomClusterClient", - "signature": [ + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_licenses.ts", + "lineNumber": 35 + } }, - " extends ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IClusterClient", - "text": "IClusterClient" - } - ], - "description": [ - "\nSee {@link IClusterClient}\n" - ], - "tags": [ - "public" - ], - "children": [ + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/lib/alerts/disable_watcher_cluster_alerts.ts", + "lineNumber": 9 + } + }, { - "tags": [], - "id": "def-server.ICustomClusterClient.close", - "type": "Function", - "label": "close", - "description": [ - "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." - ], - "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 50 - }, - "signature": [ - "() => Promise" - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 45 - }, - "initialIsOpen": false - }, - { - "id": "def-server.IExternalUrlConfig", - "type": "Interface", - "label": "IExternalUrlConfig", - "description": [ - "\nExternal Url configuration for use in Kibana." - ], - "tags": [ - "public" - ], - "children": [ + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/lib/alerts/disable_watcher_cluster_alerts.ts", + "lineNumber": 25 + } + }, { - "tags": [], - "id": "def-server.IExternalUrlConfig.policy", - "type": "Array", - "label": "policy", - "description": [ - "\nA set of policies describing which external urls are allowed." - ], - "source": { - "path": "src/core/server/external_url/external_url_config.ts", - "lineNumber": 22 - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IExternalUrlPolicy", - "text": "IExternalUrlPolicy" - }, - "[]" - ] - } - ], - "source": { - "path": "src/core/server/external_url/external_url_config.ts", - "lineNumber": 18 - }, - "initialIsOpen": false - }, - { - "id": "def-server.IExternalUrlPolicy", - "type": "Interface", - "label": "IExternalUrlPolicy", - "description": [ - "\nA policy describing whether access to an external destination is allowed." - ], - "tags": [ - "public" - ], - "children": [ + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/lib/alerts/disable_watcher_cluster_alerts.ts", + "lineNumber": 36 + } + }, { - "tags": [], - "id": "def-server.IExternalUrlPolicy.allow", - "type": "boolean", - "label": "allow", - "description": [ - "\nIndicates if this policy allows or denies access to the described destination." - ], - "source": { - "path": "src/core/server/external_url/external_url_config.ts", - "lineNumber": 33 + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_es_stats.d.ts", + "lineNumber": 2 } }, { - "tags": [], - "id": "def-server.IExternalUrlPolicy.host", - "type": "string", - "label": "host", - "description": [ - "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" - ], - "source": { - "path": "src/core/server/external_url/external_url_config.ts", - "lineNumber": 46 - }, - "signature": [ - "string | undefined" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_es_stats.d.ts", + "lineNumber": 10 + } }, { - "tags": [], - "id": "def-server.IExternalUrlPolicy.protocol", - "type": "string", - "label": "protocol", - "description": [ - "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" - ], - "source": { - "path": "src/core/server/external_url/external_url_config.ts", - "lineNumber": 59 - }, - "signature": [ - "string | undefined" - ] - } - ], - "source": { - "path": "src/core/server/external_url/external_url_config.ts", - "lineNumber": 29 - }, - "initialIsOpen": false - }, - { - "id": "def-server.ImageValidation", - "type": "Interface", - "label": "ImageValidation", - "description": [], - "tags": [ - "public" - ], - "children": [ + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_es_stats.d.ts", + "lineNumber": 20 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_high_level_stats.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_high_level_stats.d.ts", + "lineNumber": 78 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_high_level_stats.d.ts", + "lineNumber": 83 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_kibana_stats.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_kibana_stats.d.ts", + "lineNumber": 82 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_beats_stats.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_beats_stats.d.ts", + "lineNumber": 120 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_beats_stats.d.ts", + "lineNumber": 123 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_beats_stats.d.ts", + "lineNumber": 129 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_logstash_stats.d.ts", + "lineNumber": 2 + } + }, { - "tags": [], - "id": "def-server.ImageValidation.maxSize", - "type": "Object", - "label": "maxSize", - "description": [], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 132 - }, - "signature": [ - "{ length: number; description: string; }" - ] - } - ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 131 - }, - "initialIsOpen": false - }, - { - "id": "def-server.IndexSettingsDeprecationInfo", - "type": "Interface", - "label": "IndexSettingsDeprecationInfo", - "description": [], - "tags": [ - "deprecated", - "public" - ], - "children": [ + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_logstash_stats.d.ts", + "lineNumber": 100 + } + }, { - "id": "def-server.IndexSettingsDeprecationInfo.Unnamed", - "type": "Any", - "label": "Unnamed", - "tags": [], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 370 - }, - "signature": [ - "any" - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 369 - }, - "initialIsOpen": false - }, - { - "id": "def-server.IRenderOptions", - "type": "Interface", - "label": "IRenderOptions", - "description": [], - "tags": [ - "public" - ], - "children": [ + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_logstash_stats.d.ts", + "lineNumber": 103 + } + }, { - "tags": [], - "id": "def-server.IRenderOptions.includeUserSettings", - "type": "CompoundType", - "label": "includeUserSettings", - "description": [ - "\nSet whether to output user settings in the page metadata.\n`true` by default." - ], - "source": { - "path": "src/core/server/rendering/types.ts", - "lineNumber": 73 - }, - "signature": [ - "boolean | undefined" - ] - } - ], - "source": { - "path": "src/core/server/rendering/types.ts", - "lineNumber": 68 - }, - "initialIsOpen": false - }, - { - "id": "def-server.IScopedClusterClient", - "type": "Interface", - "label": "IScopedClusterClient", - "description": [ - "\nServes the same purpose as the normal {@link IClusterClient | cluster client} but exposes\nan additional `asCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers\nextracted from the current user request to the API instead.\n" - ], - "tags": [ - "public" - ], - "children": [ + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_logstash_stats.d.ts", + "lineNumber": 109 + } + }, { - "tags": [], - "id": "def-server.IScopedClusterClient.asInternalUser", - "type": "CompoundType", - "label": "asInternalUser", - "description": [ - "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user." - ], - "source": { - "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", - "lineNumber": 24 - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_all_stats.d.ts", + "lineNumber": 1 + } }, { - "tags": [], - "id": "def-server.IScopedClusterClient.asCurrentUser", - "type": "CompoundType", - "label": "asCurrentUser", - "description": [ - "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the user that initiated the request to the Kibana server." - ], - "source": { - "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", - "lineNumber": 29 - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", - "lineNumber": 19 - }, - "initialIsOpen": false - }, - { - "id": "def-server.IUiSettingsClient", - "type": "Interface", - "label": "IUiSettingsClient", - "description": [ - "\nServer-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n" - ], - "tags": [ - "public" - ], - "children": [ + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_all_stats.d.ts", + "lineNumber": 11 + } + }, { - "tags": [], - "id": "def-server.IUiSettingsClient.getRegistered", - "type": "Function", - "label": "getRegistered", - "description": [ - "\nReturns registered uiSettings values {@link UiSettingsParams}" - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 35 - }, - "signature": [ - "() => Readonly, \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"validation\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\">>>" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_cluster_uuids.d.ts", + "lineNumber": 1 + } }, { - "tags": [], - "id": "def-server.IUiSettingsClient.get", - "type": "Function", - "label": "get", - "description": [ - "\nRetrieves uiSettings values set by the user with fallbacks to default values if not specified." - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 39 - }, - "signature": [ - "(key: string) => Promise" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_cluster_uuids.d.ts", + "lineNumber": 5 + } }, { - "tags": [], - "id": "def-server.IUiSettingsClient.getAll", - "type": "Function", - "label": "getAll", - "description": [ - "\nRetrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified." - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 43 - }, - "signature": [ - "() => Promise>" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_cluster_uuids.d.ts", + "lineNumber": 10 + } }, { - "tags": [], - "id": "def-server.IUiSettingsClient.getUserProvided", - "type": "Function", - "label": "getUserProvided", - "description": [ - "\nRetrieves a set of all uiSettings values set by the user." - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 47 - }, - "signature": [ - "() => Promise>>" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_licenses.d.ts", + "lineNumber": 2 + } }, { - "tags": [], - "id": "def-server.IUiSettingsClient.setMany", - "type": "Function", - "label": "setMany", - "description": [ - "\nWrites multiple uiSettings values and marks them as set by the user." - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 51 - }, - "signature": [ - "(changes: Record) => Promise" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_licenses.d.ts", + "lineNumber": 7 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_licenses.d.ts", + "lineNumber": 20 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/lib/alerts/disable_watcher_cluster_alerts.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/lib/alerts/disable_watcher_cluster_alerts.d.ts", + "lineNumber": 3 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_es_usage.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_es_usage.d.ts", + "lineNumber": 4 + } }, { - "tags": [], - "id": "def-server.IUiSettingsClient.set", - "type": "Function", - "label": "set", - "description": [ - "\nWrites uiSettings value and marks it as set by the user." - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 55 - }, - "signature": [ - "(key: string, value: any) => Promise" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_license_type.d.ts", + "lineNumber": 1 + } }, { - "tags": [], - "id": "def-server.IUiSettingsClient.remove", - "type": "Function", - "label": "remove", - "description": [ - "\nRemoves uiSettings value by key." - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 59 - }, - "signature": [ - "(key: string) => Promise" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_license_type.d.ts", + "lineNumber": 2 + } }, { - "tags": [], - "id": "def-server.IUiSettingsClient.removeMany", - "type": "Function", - "label": "removeMany", - "description": [ - "\nRemoves multiple uiSettings values by keys." - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 63 - }, - "signature": [ - "(keys: string[]) => Promise" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_stack_product_usage.d.ts", + "lineNumber": 1 + } }, { - "tags": [], - "id": "def-server.IUiSettingsClient.isOverridden", - "type": "Function", - "label": "isOverridden", - "description": [ - "\nShows whether the uiSettings value set by the user." - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 67 - }, - "signature": [ - "(key: string) => boolean" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_stack_product_usage.d.ts", + "lineNumber": 4 + } }, { - "tags": [], - "id": "def-server.IUiSettingsClient.isSensitive", - "type": "Function", - "label": "isSensitive", - "description": [ - "\nShows whether the uiSetting is a sensitive value. Used by telemetry to not send sensitive values." - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 71 - }, - "signature": [ - "(key: string) => boolean" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/get_stack_products_usage.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/get_stack_products_usage.d.ts", + "lineNumber": 4 + } } ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 31 - }, - "initialIsOpen": false - }, - { - "id": "def-server.LegacyAPICaller", - "type": "Interface", - "label": "LegacyAPICaller", - "description": [], - "tags": [ - "deprecated", - "public" - ], "children": [ { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 164 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 165 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 166 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 167 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 168 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 169 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 170 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 171 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 172 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 173 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 174 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 176 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 177 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 178 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 179 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 181 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 182 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 184 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 185 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 186 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 187 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 188 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 189 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 190 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 191 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 192 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 193 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 195 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 196 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 197 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 198 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 199 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 200 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 201 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 202 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 205 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 206 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 207 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 208 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 209 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 210 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 211 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 212 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 213 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 214 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 215 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 216 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 217 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 218 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 219 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 220 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 221 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 222 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 223 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 226 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 227 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 228 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 229 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 230 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 231 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 232 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 233 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 236 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 237 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 238 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 239 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 240 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 241 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 242 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 243 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 244 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 245 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 246 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 247 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 248 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 249 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 250 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 251 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 252 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 253 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 254 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 255 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 256 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 257 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 258 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 259 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 260 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 261 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 262 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 263 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 264 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 265 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 266 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 267 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 268 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 269 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 270 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 271 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 274 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 275 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 276 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 277 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 280 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 281 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 282 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 285 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 286 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 287 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 288 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 289 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 290 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 291 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 292 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 293 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 296 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 297 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 298 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 301 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 304 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 309 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 162 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LegacyCallAPIOptions", "type": "Interface", + "tags": [ + "deprecated" + ], "label": "LegacyCallAPIOptions", "description": [ "\nThe set of options that defines how API call should be made and result be\nprocessed.\n" ], - "tags": [ - "public", - "deprecated" + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 144 + }, + "deprecated": true, + "references": [ + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/types.ts", + "lineNumber": 53 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/types.ts", + "lineNumber": 110 + } + } ], "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.LegacyCallAPIOptions.wrap401Errors", "type": "CompoundType", + "tags": [], "label": "wrap401Errors", "description": [ "\nIndicates whether `401 Unauthorized` errors returned from the Elasticsearch API\nshould be wrapped into `Boom` error instances with properly set `WWW-Authenticate`\nheader that could have been returned by the API itself. If API didn't specify that\nthen `Basic realm=\"Authorization Required\"` is used as `WWW-Authenticate`." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 151 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.LegacyCallAPIOptions.signal", "type": "Object", + "tags": [], "label": "signal", "description": [ "\nA signal object that allows you to abort the request via an AbortController object." ], + "signature": [ + "AbortSignal | undefined" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 155 }, - "signature": [ - "AbortSignal | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 144 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LegacyElasticsearchError", "type": "Interface", + "tags": [ + "deprecated" + ], "label": "LegacyElasticsearchError", + "description": [], "signature": [ { "pluginId": "core", @@ -12749,431 +16146,490 @@ "Boom", "" ], - "description": [], - "tags": [ - "deprecated", - "public" - ], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 22 + }, + "deprecated": true, + "references": [], "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.LegacyElasticsearchError.code", "type": "string", + "tags": [], "label": "[code]", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/elasticsearch/legacy/errors.ts", "lineNumber": 23 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/legacy/errors.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.Logger", "type": "Interface", + "tags": [], "label": "Logger", - "signature": [ - "Logger" - ], "description": [ "\nLogger exposes all the necessary methods to log any type of information and\nthis is the interface used by the logging consumers including plugins.\n" ], - "tags": [ - "public" + "signature": [ + "Logger" ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Logger.trace", "type": "Function", + "tags": [], "label": "trace", - "signature": [ - "(message: string, meta?: ", - "LogMeta", - " | undefined) => void" - ], "description": [ "\nLog messages at the most detailed log level\n" ], + "signature": [ + "(message: string, meta?: Meta | undefined) => void" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Logger.trace.$1", "type": "string", + "tags": [], "label": "message", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The log message" ], + "signature": [ + "string" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 23 - } + "lineNumber": 16 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.trace.$2", - "type": "Object", + "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "LogMeta", - " | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 23 - } + "lineNumber": 16 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 23 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.debug", "type": "Function", + "tags": [], "label": "debug", - "signature": [ - "(message: string, meta?: ", - "LogMeta", - " | undefined) => void" - ], "description": [ "\nLog messages useful for debugging and interactive investigation" ], + "signature": [ + "(message: string, meta?: Meta | undefined) => void" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Logger.debug.$1", "type": "string", + "tags": [], "label": "message", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The log message" ], + "signature": [ + "string" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 29 - } + "lineNumber": 22 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.debug.$2", - "type": "Object", + "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "LogMeta", - " | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 29 - } + "lineNumber": 22 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 29 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.info", "type": "Function", + "tags": [], "label": "info", - "signature": [ - "(message: string, meta?: ", - "LogMeta", - " | undefined) => void" - ], "description": [ "\nLogs messages related to general application flow" ], + "signature": [ + "(message: string, meta?: Meta | undefined) => void" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Logger.info.$1", "type": "string", + "tags": [], "label": "message", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The log message" ], + "signature": [ + "string" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 35 - } + "lineNumber": 28 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.info.$2", - "type": "Object", + "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "LogMeta", - " | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 35 - } + "lineNumber": 28 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 35 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.warn", "type": "Function", + "tags": [], "label": "warn", - "signature": [ - "(errorOrMessage: string | Error, meta?: ", - "LogMeta", - " | undefined) => void" - ], "description": [ "\nLogs abnormal or unexpected errors or messages" ], + "signature": [ + "(errorOrMessage: string | Error, meta?: Meta | undefined) => void" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Logger.warn.$1", "type": "CompoundType", + "tags": [], "label": "errorOrMessage", - "isRequired": true, - "signature": [ - "string | Error" - ], "description": [ "- An Error object or message string to log" ], + "signature": [ + "string | Error" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 41 - } + "lineNumber": 34 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.warn.$2", - "type": "Object", + "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "LogMeta", - " | undefined" - ], "description": [ "-" ], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 41 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 41 - } + "signature": [ + "Meta | undefined" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 34 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.error", "type": "Function", + "tags": [], "label": "error", - "signature": [ - "(errorOrMessage: string | Error, meta?: ", - "LogMeta", - " | undefined) => void" - ], "description": [ "\nLogs abnormal or unexpected errors or messages that caused a failure in the application flow\n" ], + "signature": [ + "(errorOrMessage: string | Error, meta?: Meta | undefined) => void" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Logger.error.$1", "type": "CompoundType", + "tags": [], "label": "errorOrMessage", - "isRequired": true, - "signature": [ - "string | Error" - ], "description": [ "- An Error object or message string to log" ], + "signature": [ + "string | Error" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 48 - } + "lineNumber": 41 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.error.$2", - "type": "Object", + "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "LogMeta", - " | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 48 - } + "lineNumber": 41 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 48 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.fatal", "type": "Function", + "tags": [], "label": "fatal", - "signature": [ - "(errorOrMessage: string | Error, meta?: ", - "LogMeta", - " | undefined) => void" - ], "description": [ "\nLogs abnormal or unexpected errors or messages that caused an unrecoverable failure\n" ], + "signature": [ + "(errorOrMessage: string | Error, meta?: Meta | undefined) => void" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Logger.fatal.$1", "type": "CompoundType", + "tags": [], "label": "errorOrMessage", - "isRequired": true, - "signature": [ - "string | Error" - ], "description": [ "- An Error object or message string to log" ], + "signature": [ + "string | Error" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 55 - } + "lineNumber": 48 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.fatal.$2", - "type": "Object", + "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "LogMeta", - " | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 55 - } + "lineNumber": 48 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 55 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.get", "type": "Function", + "tags": [], "label": "get", + "description": [ + "\nReturns a new {@link Logger} instance extending the current logger context.\n" + ], "signature": [ "(...childContextPaths: string[]) => ", "Logger" ], - "description": [ - "\nReturns a new {@link Logger} instance extending the current logger context.\n" - ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Logger.get.$1", "type": "Array", + "tags": [], "label": "childContextPaths", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 67 - } + "lineNumber": 60 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 67 - } + "returnComment": [] } ], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LoggerContextConfigInput", "type": "Interface", + "tags": [], "label": "LoggerContextConfigInput", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/logging/logging_config.ts", + "lineNumber": 111 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.LoggerContextConfigInput.appenders", "type": "CompoundType", + "tags": [], "label": "appenders", "description": [], - "source": { - "path": "src/core/server/logging/logging_config.ts", - "lineNumber": 113 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "src/core/server/logging/logging_config.ts", + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.LoggerContextConfigInput.loggers", "type": "Array", + "tags": [], "label": "loggers", "description": [], - "source": { - "path": "src/core/server/logging/logging_config.ts", - "lineNumber": 114 - }, "signature": [ "Readonly<{} & { name: string; level: ", "LogLevelId", "; appenders: string[]; }>[] | undefined" - ] + ], + "source": { + "path": "src/core/server/logging/logging_config.ts", + "lineNumber": 114 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/logging/logging_config.ts", - "lineNumber": 111 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LoggerFactory", "type": "Interface", + "tags": [], "label": "LoggerFactory", - "signature": [ - "LoggerFactory" - ], "description": [ "\nThe single purpose of `LoggerFactory` interface is to define a way to\nretrieve a context-based logger instance.\n" ], - "tags": [ - "public" + "signature": [ + "LoggerFactory" ], + "source": { + "path": "node_modules/@kbn/logging/target/logger_factory.d.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.LoggerFactory.get", "type": "Function", + "tags": [], "label": "get", + "description": [ + "\nReturns a `Logger` instance for the specified context.\n" + ], "signature": [ "(...contextParts: string[]) => ", "Logger" ], - "description": [ - "\nReturns a `Logger` instance for the specified context.\n" - ], + "source": { + "path": "node_modules/@kbn/logging/target/logger_factory.d.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.LoggerFactory.get.$1", "type": "Array", + "tags": [], "label": "contextParts", - "isRequired": true, - "signature": [ - "string[]" - ], "description": [ "- Parts of the context to return logger for. For example\nget('plugins', 'pid') will return a logger for the `plugins.pid` context." ], + "signature": [ + "string[]" + ], "source": { "path": "node_modules/@kbn/logging/target/logger_factory.d.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger_factory.d.ts", - "lineNumber": 15 - } + "returnComment": [] } ], - "source": { - "path": "node_modules/@kbn/logging/target/logger_factory.d.ts", - "lineNumber": 8 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LoggingServiceSetup", "type": "Interface", + "tags": [], "label": "LoggingServiceSetup", "description": [ "\nProvides APIs to plugins for customizing the plugin's logger." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/logging/logging_service.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.LoggingServiceSetup.configure", "type": "Function", + "tags": [], "label": "configure", + "description": [ + "\nCustomizes the logging config for the plugin's context.\n" + ], "signature": [ "(config$: ", "Observable", @@ -13299,101 +16772,67 @@ "docId": "kibCorePluginApi", "section": "def-server.LoggerContextConfigInput", "text": "LoggerContextConfigInput" - }, - ">) => void" - ], - "description": [ - "\nCustomizes the logging config for the plugin's context.\n" - ], - "children": [ - { - "id": "def-server.LoggingServiceSetup.configure.$1", - "type": "Object", - "label": "config$", - "isRequired": true, - "signature": [ - "Observable", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LoggerContextConfigInput", - "text": "LoggerContextConfigInput" - }, - ">" - ], - "description": [], - "source": { - "path": "src/core/server/logging/logging_service.ts", - "lineNumber": 41 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/logging/logging_service.ts", - "lineNumber": 41 - } - } - ], - "source": { - "path": "src/core/server/logging/logging_service.ts", - "lineNumber": 20 - }, - "initialIsOpen": false - }, - { - "id": "def-server.LogMeta", - "type": "Interface", - "label": "LogMeta", - "signature": [ - "LogMeta" - ], - "description": [ - "\nContextual metadata\n" - ], - "tags": [ - "public" - ], - "children": [ - { - "id": "def-server.LogMeta.Unnamed", - "type": "Any", - "label": "Unnamed", - "tags": [], - "description": [], + }, + ">) => void" + ], "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 8 + "path": "src/core/server/logging/logging_service.ts", + "lineNumber": 41 }, - "signature": [ - "any" - ] + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.LoggingServiceSetup.configure.$1", + "type": "Object", + "tags": [], + "label": "config$", + "description": [], + "signature": [ + "Observable", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LoggerContextConfigInput", + "text": "LoggerContextConfigInput" + }, + ">" + ], + "source": { + "path": "src/core/server/logging/logging_service.ts", + "lineNumber": 41 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 7 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.MetricsServiceSetup", "type": "Interface", + "tags": [], "label": "MetricsServiceSetup", "description": [ "\nAPIs to retrieves metrics gathered and exposed by the core platform.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.MetricsServiceSetup.collectionInterval", "type": "number", + "tags": [], "label": "collectionInterval", "description": [ "Interval metrics are collected in milliseconds" @@ -13401,20 +16840,18 @@ "source": { "path": "src/core/server/metrics/types.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.MetricsServiceSetup.getOpsMetrics$", "type": "Function", + "tags": [], "label": "getOpsMetrics$", "description": [ "\nRetrieve an observable emitting the {@link OpsMetrics} gathered.\nThe observable will emit an initial value during core's `start` phase, and a new value every fixed interval of time,\nbased on the `opts.interval` configuration property.\n" ], - "source": { - "path": "src/core/server/metrics/types.ts", - "lineNumber": 33 - }, "signature": [ "() => ", "Observable", @@ -13427,132 +16864,148 @@ "text": "OpsMetrics" }, ">" - ] + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 33 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/metrics/types.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.NodesVersionCompatibility", "type": "Interface", + "tags": [], "label": "NodesVersionCompatibility", "description": [], - "tags": [], + "source": { + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.NodesVersionCompatibility.isCompatible", "type": "boolean", + "tags": [], "label": "isCompatible", "description": [], "source": { "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", "lineNumber": 47 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.NodesVersionCompatibility.message", "type": "string", + "tags": [], "label": "message", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", "lineNumber": 48 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.NodesVersionCompatibility.incompatibleNodes", "type": "Array", + "tags": [], "label": "incompatibleNodes", "description": [], + "signature": [ + "NodeInfo[]" + ], "source": { "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", "lineNumber": 49 }, - "signature": [ - "NodeInfo[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.NodesVersionCompatibility.warningNodes", "type": "Array", + "tags": [], "label": "warningNodes", "description": [], + "signature": [ + "NodeInfo[]" + ], "source": { "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", "lineNumber": 50 }, - "signature": [ - "NodeInfo[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.NodesVersionCompatibility.kibanaVersion", "type": "string", + "tags": [], "label": "kibanaVersion", "description": [], "source": { "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", "lineNumber": 51 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "lineNumber": 46 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OpsMetrics", "type": "Interface", + "tags": [], "label": "OpsMetrics", "description": [ "\nRegroups metrics gathered by all the collectors.\nThis contains metrics about the os/runtime, the kibana process and the http server.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsMetrics.collected_at", "type": "Object", + "tags": [], "label": "collected_at", "description": [ "Time metrics were recorded at." ], + "signature": [ + "Date" + ], "source": { "path": "src/core/server/metrics/types.ts", "lineNumber": 53 }, - "signature": [ - "Date" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsMetrics.process", "type": "Object", + "tags": [], "label": "process", "description": [ "Process related metrics" ], - "source": { - "path": "src/core/server/metrics/types.ts", - "lineNumber": 55 - }, "signature": [ { "pluginId": "core", @@ -13561,20 +17014,22 @@ "section": "def-server.OpsProcessMetrics", "text": "OpsProcessMetrics" } - ] + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsMetrics.os", "type": "Object", + "tags": [], "label": "os", "description": [ "OS related metrics" ], - "source": { - "path": "src/core/server/metrics/types.ts", - "lineNumber": 57 - }, "signature": [ { "pluginId": "core", @@ -13583,44 +17038,54 @@ "section": "def-server.OpsOsMetrics", "text": "OpsOsMetrics" } - ] + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 57 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsMetrics.response_times", "type": "Object", + "tags": [], "label": "response_times", "description": [ "server response time stats" ], + "signature": [ + "{ avg_in_millis: number; max_in_millis: number; }" + ], "source": { "path": "src/core/server/metrics/types.ts", "lineNumber": 59 }, - "signature": [ - "{ avg_in_millis: number; max_in_millis: number; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsMetrics.requests", "type": "Object", + "tags": [], "label": "requests", "description": [ "server requests stats" ], + "signature": [ + "{ disconnects: number; total: number; statusCodes: Record; }" + ], "source": { "path": "src/core/server/metrics/types.ts", "lineNumber": 61 }, - "signature": [ - "{ disconnects: number; total: number; statusCodes: Record; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsMetrics.concurrent_connections", "type": "number", + "tags": [], "label": "concurrent_connections", "description": [ "number of current concurrent connections to the server" @@ -13628,46 +17093,50 @@ "source": { "path": "src/core/server/metrics/types.ts", "lineNumber": 63 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/metrics/types.ts", - "lineNumber": 51 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OpsOsMetrics", "type": "Interface", + "tags": [], "label": "OpsOsMetrics", "description": [ "\nOS related metrics" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsOsMetrics.platform", "type": "CompoundType", + "tags": [], "label": "platform", "description": [ "The os platform" ], + "signature": [ + "NodeJS.Platform" + ], "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 50 }, - "signature": [ - "NodeJS.Platform" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsOsMetrics.platformRelease", "type": "string", + "tags": [], "label": "platformRelease", "description": [ "The os platform release, prefixed by the platform name" @@ -13675,76 +17144,86 @@ "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 52 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsOsMetrics.distro", "type": "string", + "tags": [], "label": "distro", "description": [ "The os distrib. Only present for linux platforms" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 54 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsOsMetrics.distroRelease", "type": "string", + "tags": [], "label": "distroRelease", "description": [ "The os distrib release, prefixed by the os distrib. Only present for linux platforms" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 56 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsOsMetrics.load", "type": "Object", + "tags": [], "label": "load", "description": [ "cpu load metrics" ], + "signature": [ + "{ '1m': number; '5m': number; '15m': number; }" + ], "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 58 }, - "signature": [ - "{ '1m': number; '5m': number; '15m': number; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsOsMetrics.memory", "type": "Object", + "tags": [], "label": "memory", "description": [ "system memory usage metrics" ], + "signature": [ + "{ total_in_bytes: number; free_in_bytes: number; used_in_bytes: number; }" + ], "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 67 }, - "signature": [ - "{ total_in_bytes: number; free_in_bytes: number; used_in_bytes: number; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsOsMetrics.uptime_in_millis", "type": "number", + "tags": [], "label": "uptime_in_millis", "description": [ "the OS uptime" @@ -13752,78 +17231,86 @@ "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 76 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsOsMetrics.cpuacct", "type": "Object", + "tags": [], "label": "cpuacct", "description": [ "cpu accounting metrics, undefined when not running in a cgroup" ], + "signature": [ + "{ control_group: string; usage_nanos: number; } | undefined" + ], "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 79 }, - "signature": [ - "{ control_group: string; usage_nanos: number; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsOsMetrics.cpu", "type": "Object", + "tags": [], "label": "cpu", "description": [ "cpu cgroup metrics, undefined when not running in a cgroup" ], + "signature": [ + "{ control_group: string; cfs_period_micros: number; cfs_quota_micros: number; stat: { number_of_elapsed_periods: number; number_of_times_throttled: number; time_throttled_nanos: number; }; } | undefined" + ], "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 87 }, - "signature": [ - "{ control_group: string; cfs_period_micros: number; cfs_quota_micros: number; stat: { number_of_elapsed_periods: number; number_of_times_throttled: number; time_throttled_nanos: number; }; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/metrics/collectors/types.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OpsProcessMetrics", "type": "Interface", + "tags": [], "label": "OpsProcessMetrics", "description": [ "\nProcess related metrics" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsProcessMetrics.memory", "type": "Object", + "tags": [], "label": "memory", "description": [ "process memory usage" ], + "signature": [ + "{ heap: { total_in_bytes: number; used_in_bytes: number; size_limit: number; }; resident_set_size_in_bytes: number; }" + ], "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 23 }, - "signature": [ - "{ heap: { total_in_bytes: number; used_in_bytes: number; size_limit: number; }; resident_set_size_in_bytes: number; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsProcessMetrics.event_loop_delay", "type": "number", + "tags": [], "label": "event_loop_delay", "description": [ "node event loop delay" @@ -13831,12 +17318,14 @@ "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 37 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsProcessMetrics.pid", "type": "number", + "tags": [], "label": "pid", "description": [ "pid of the kibana process" @@ -13844,12 +17333,14 @@ "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 39 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsProcessMetrics.uptime_in_millis", "type": "number", + "tags": [], "label": "uptime_in_millis", "description": [ "uptime of the kibana process" @@ -13857,62 +17348,68 @@ "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 41 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/metrics/collectors/types.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OpsServerMetrics", "type": "Interface", + "tags": [], "label": "OpsServerMetrics", "description": [ "\nserver related metrics" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 110 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsServerMetrics.response_times", "type": "Object", + "tags": [], "label": "response_times", "description": [ "server response time stats" ], + "signature": [ + "{ avg_in_millis: number; max_in_millis: number; }" + ], "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 112 }, - "signature": [ - "{ avg_in_millis: number; max_in_millis: number; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsServerMetrics.requests", "type": "Object", + "tags": [], "label": "requests", "description": [ "server requests stats" ], + "signature": [ + "{ disconnects: number; total: number; statusCodes: Record; }" + ], "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 119 }, - "signature": [ - "{ disconnects: number; total: number; statusCodes: Record; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OpsServerMetrics.concurrent_connections", "type": "number", + "tags": [], "label": "concurrent_connections", "description": [ "number of current concurrent connections to the server" @@ -13920,93 +17417,105 @@ "source": { "path": "src/core/server/metrics/collectors/types.ts", "lineNumber": 128 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/metrics/collectors/types.ts", - "lineNumber": 110 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PackageInfo", "type": "Interface", + "tags": [], "label": "PackageInfo", + "description": [], "signature": [ "PackageInfo" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 4 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.PackageInfo.version", "type": "string", + "tags": [], "label": "version", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 5 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PackageInfo.branch", "type": "string", + "tags": [], "label": "branch", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 6 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PackageInfo.buildNum", "type": "number", + "tags": [], "label": "buildNum", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 7 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PackageInfo.buildSha", "type": "string", + "tags": [], "label": "buildSha", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 8 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PackageInfo.dist", "type": "boolean", + "tags": [], "label": "dist", "description": [], "source": { "path": "node_modules/@kbn/config/target/types.d.ts", "lineNumber": 9 - } + }, + "deprecated": false } ], - "source": { - "path": "node_modules/@kbn/config/target/types.d.ts", - "lineNumber": 4 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.Plugin", "type": "Interface", + "tags": [], "label": "Plugin", + "description": [ + "\nThe interface that should be returned by a `PluginInitializer`.\n" + ], "signature": [ { "pluginId": "core", @@ -14017,17 +17526,19 @@ }, "" ], - "description": [ - "\nThe interface that should be returned by a `PluginInitializer`.\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 282 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Plugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -14039,13 +17550,19 @@ }, ", plugins: TPluginsSetup) => TSetup" ], - "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 288 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Plugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -14056,38 +17573,40 @@ }, "" ], - "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 255 - } + "lineNumber": 288 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Plugin.setup.$2", "type": "Uncategorized", + "tags": [], "label": "plugins", - "isRequired": true, + "description": [], "signature": [ "TPluginsSetup" ], - "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 255 - } + "lineNumber": 288 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 255 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Plugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -14099,13 +17618,19 @@ }, ", plugins: TPluginsStart) => TStart" ], - "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 290 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.Plugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -14115,61 +17640,63 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 257 - } + "lineNumber": 290 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Plugin.start.$2", "type": "Uncategorized", + "tags": [], "label": "plugins", - "isRequired": true, + "description": [], "signature": [ "TPluginsStart" ], - "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 257 - } + "lineNumber": 290 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 257 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Plugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "(() => void) | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 259 - } + "lineNumber": 292 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 249 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PluginConfigDescriptor", "type": "Interface", + "tags": [], "label": "PluginConfigDescriptor", + "description": [ + "\nDescribes a plugin configuration properties.\n" + ], "signature": [ { "pluginId": "core", @@ -14180,58 +17707,58 @@ }, "" ], - "description": [ - "\nDescribes a plugin configuration properties.\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginConfigDescriptor.deprecations", "type": "Function", + "tags": [], "label": "deprecations", "description": [ "\nProvider for the {@link ConfigDeprecation} to apply to the plugin configuration." ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 62 - }, "signature": [ "ConfigDeprecationProvider", " | undefined" - ] + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 64 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginConfigDescriptor.exposeToBrowser", "type": "Object", + "tags": [], "label": "exposeToBrowser", "description": [ "\nList of configuration properties that will be available on the client-side plugin." ], + "signature": [ + "{ [P in keyof T]?: boolean | undefined; } | undefined" + ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 66 + "lineNumber": 68 }, - "signature": [ - "{ [P in keyof T]?: boolean | undefined; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginConfigDescriptor.schema", "type": "Object", + "tags": [], "label": "schema", "description": [ "\nSchema to use to validate the plugin configuration.\n\n{@link PluginConfigSchema}" ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 72 - }, "signature": [ { "pluginId": "core", @@ -14241,19 +17768,50 @@ "text": "PluginConfigSchema" }, "" - ] + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 74 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PluginConfigDescriptor.exposeToUsage", + "type": "Object", + "tags": [], + "label": "exposeToUsage", + "description": [ + "\nExpose non-default configs to usage collection to be sent via telemetry.\nset a config to `true` to report the actual changed config value.\nset a config to `false` to report the changed config value as [redacted].\n\nAll changed configs except booleans and numbers will be reported\nas [redacted] unless otherwise specified.\n\n{@link MakeUsageFromSchema}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MakeUsageFromSchema", + "text": "MakeUsageFromSchema" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 85 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 58 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PluginInitializerContext", "type": "Interface", + "tags": [], "label": "PluginInitializerContext", + "description": [ + "\nContext that's available to plugins during initialization stage.\n" + ], "signature": [ { "pluginId": "core", @@ -14264,73 +17822,75 @@ }, "" ], - "description": [ - "\nContext that's available to plugins during initialization stage.\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 337 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginInitializerContext.opaqueId", "type": "Uncategorized", + "tags": [], "label": "opaqueId", "description": [], + "signature": [ + "symbol" + ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 305 + "lineNumber": 338 }, - "signature": [ - "symbol" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginInitializerContext.env", "type": "Object", + "tags": [], "label": "env", "description": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 306 - }, "signature": [ "{ mode: ", "EnvironmentMode", "; packageInfo: Readonly<", "PackageInfo", ">; instanceUuid: string; }" - ] + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 339 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginInitializerContext.logger", "type": "Object", + "tags": [], "label": "logger", "description": [ "\n{@link LoggerFactory | logger factory} instance already bound to the plugin's logging context\n" ], + "signature": [ + "LoggerFactory" + ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 329 + "lineNumber": 362 }, - "signature": [ - "LoggerFactory" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginInitializerContext.config", "type": "Object", + "tags": [], "label": "config", "description": [ "\nAccessors for the plugin's configuration" ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 333 - }, "signature": [ "{ legacy: { globalConfig$: ", "Observable", @@ -14342,213 +17902,240 @@ "ByteSizeValue", ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>>; get: () => Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly autocompleteTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", "ByteSizeValue" - ] + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 366 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 304 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PluginManifest", "type": "Interface", + "tags": [], "label": "PluginManifest", "description": [ "\nDescribes the set of required and optional properties plugin can define in its\nmandatory JSON manifest file.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 135 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nIdentifier of the plugin. Must be a string in camelCase. Part of a plugin public contract.\nOther plugins leverage it to access plugin API, navigate to the plugin, etc." ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 107 - } + "lineNumber": 140 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.version", "type": "string", + "tags": [], "label": "version", "description": [ "\nVersion of the plugin." ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 112 - } + "lineNumber": 145 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.kibanaVersion", "type": "string", + "tags": [], "label": "kibanaVersion", "description": [ "\nThe version of Kibana the plugin is compatible with, defaults to \"version\"." ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 117 - } + "lineNumber": 150 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.configPath", "type": "CompoundType", + "tags": [], "label": "configPath", "description": [ "\nRoot {@link ConfigPath | configuration path} used by the plugin, defaults\nto \"id\" in snake_case format.\n" ], + "signature": [ + "string | string[]" + ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 127 + "lineNumber": 160 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.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[]" + ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 133 + "lineNumber": 166 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.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[]" + ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 145 + "lineNumber": 178 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.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[]" + ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 152 + "lineNumber": 185 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.ui", "type": "boolean", + "tags": [], "label": "ui", "description": [ "\nSpecifies whether plugin includes some client/browser specific functionality\nthat should be included into client bundle via `public/ui_plugin.js` file." ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 158 - } + "lineNumber": 191 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.server", "type": "boolean", + "tags": [], "label": "server", "description": [ "\nSpecifies whether plugin includes some server-side specific functionality." ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 163 - } + "lineNumber": 196 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.PluginManifest.extraPublicDirs", + "type": "Array", "tags": [ "deprecated" ], - "id": "def-server.PluginManifest.extraPublicDirs", - "type": "Array", "label": "extraPublicDirs", "description": [ "\nSpecifies directory names that can be imported by other ui-plugins built\nusing the same instance of the @kbn/optimizer. A temporary measure we plan\nto replace with better mechanisms for sharing static code between plugins" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 171 + "lineNumber": 204 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.serviceFolders", "type": "Object", + "tags": [], "label": "serviceFolders", "description": [ "\nOnly used for the automatically generated API documentation. Specifying service\nfolders will cause your plugin API reference to be broken up into sub sections." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 177 + "lineNumber": 210 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 102 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RegisterDeprecationsConfig", "type": "Interface", + "tags": [], "label": "RegisterDeprecationsConfig", "description": [], - "tags": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.RegisterDeprecationsConfig.getDeprecations", "type": "Function", + "tags": [], "label": "getDeprecations", "description": [], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 57 - }, "signature": [ "(context: ", { @@ -14567,36 +18154,38 @@ "text": "DeprecationsDetails" }, "[]>" - ] + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 57 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 56 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RequestHandlerContext", "type": "Interface", + "tags": [], "label": "RequestHandlerContext", "description": [ "\nPlugin specific context passed to a route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link LegacyScopedClusterClient | elasticsearch.legacy.client} - The legacy Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 439 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.RequestHandlerContext.core", "type": "Object", + "tags": [], "label": "core", "description": [], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 432 - }, "signature": [ "{ savedObjects: { client: Pick<", { @@ -14638,30 +18227,36 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" } - ] + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 440 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 431 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ResolveCapabilitiesOptions", "type": "Interface", + "tags": [], "label": "ResolveCapabilitiesOptions", "description": [ "\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 101 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.ResolveCapabilitiesOptions.useDefaultCapabilities", "type": "boolean", + "tags": [], "label": "useDefaultCapabilities", "description": [ "\nIndicates if capability switchers are supposed to return a default set of capabilities." @@ -14669,30 +18264,34 @@ "source": { "path": "src/core/server/capabilities/capabilities_service.ts", "lineNumber": 105 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 101 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObject", "type": "Interface", + "tags": [], "label": "SavedObject", + "description": [], "signature": [ "SavedObject", "" ], - "description": [], - "tags": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.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`" @@ -14700,12 +18299,14 @@ "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 71 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObject.type", "type": "string", + "tags": [], "label": "type", "description": [ " The type of Saved Object. Each plugin can define it's own custom Saved Object types." @@ -14713,279 +18314,307 @@ "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 73 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.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" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 75 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObject.updated_at", "type": "string", + "tags": [], "label": "updated_at", "description": [ "Timestamp of the last time this document had been updated." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 77 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObject.error", "type": "Object", + "tags": [], "label": "error", "description": [], + "signature": [ + "SavedObjectError", + " | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 78 }, - "signature": [ - "SavedObjectError", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObject.attributes", "type": "Uncategorized", + "tags": [], "label": "attributes", "description": [ "{@inheritdoc SavedObjectAttributes}" ], + "signature": [ + "T" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 80 }, - "signature": [ - "T" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObject.references", "type": "Array", + "tags": [], "label": "references", "description": [ "{@inheritdoc SavedObjectReference}" ], + "signature": [ + "SavedObjectReference", + "[]" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 82 }, - "signature": [ - "SavedObjectReference", - "[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObject.migrationVersion", "type": "Object", + "tags": [], "label": "migrationVersion", "description": [ "{@inheritdoc SavedObjectsMigrationVersion}" ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 84 }, - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObject.coreMigrationVersion", "type": "string", + "tags": [], "label": "coreMigrationVersion", "description": [ "A semver value that is used when upgrading objects between Kibana versions." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 86 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObject.namespaces", "type": "Array", + "tags": [], "label": "namespaces", "description": [ "Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 88 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.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" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 95 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 69 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectAttributes", "type": "Interface", + "tags": [], "label": "SavedObjectAttributes", "description": [ "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectAttributes.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 36 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectReference", "type": "Interface", + "tags": [], "label": "SavedObjectReference", "description": [ "\nA reference to another saved object.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectReference.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 45 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectReference.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 46 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectReference.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 47 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsMigrationVersion", "type": "Interface", + "tags": [], "label": "SavedObjectsMigrationVersion", "description": [ "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsMigrationVersion.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 66 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 65 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SearchResponse", "type": "Interface", + "tags": [], "label": "SearchResponse", + "description": [], "signature": [ { "pluginId": "core", @@ -14996,57 +18625,61 @@ }, "" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 79 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SearchResponse.took", "type": "number", + "tags": [], "label": "took", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 80 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SearchResponse.timed_out", "type": "boolean", + "tags": [], "label": "timed_out", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 81 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SearchResponse._scroll_id", "type": "string", + "tags": [], "label": "_scroll_id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 82 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SearchResponse._shards", "type": "Object", + "tags": [], "label": "_shards", "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 83 - }, "signature": [ { "pluginId": "core", @@ -15055,63 +18688,75 @@ "section": "def-server.ShardsResponse", "text": "ShardsResponse" } - ] + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 83 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SearchResponse.hits", "type": "Object", + "tags": [], "label": "hits", "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 84 - }, "signature": [ "{ total: number; max_score: number; hits: { _index: string; _type: string; _id: string; _score: number; _source: T; _version?: number | undefined; _explanation?: ", "Explanation", " | undefined; fields?: any; highlight?: any; inner_hits?: any; matched_queries?: string[] | undefined; sort?: unknown[] | undefined; }[]; }" - ] + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 84 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SearchResponse.aggregations", "type": "Any", + "tags": [], "label": "aggregations", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 102 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SearchResponse.pit_id", "type": "string", + "tags": [], "label": "pit_id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 103 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 79 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ServiceStatus", "type": "Interface", + "tags": [], "label": "ServiceStatus", + "description": [ + "\nThe current status of a service at a point in time.\n" + ], "signature": [ { "pluginId": "core", @@ -15122,25 +18767,21 @@ }, "" ], - "description": [ - "\nThe current status of a service at a point in time.\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.ServiceStatus.level", "type": "CompoundType", + "tags": [], "label": "level", "description": [ "\nThe current availability level of the service." ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 24 - }, "signature": [ { "pluginId": "core", @@ -15149,12 +18790,18 @@ "section": "def-server.ServiceStatusLevel", "text": "ServiceStatusLevel" } - ] + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 24 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ServiceStatus.summary", "type": "string", + "tags": [], "label": "summary", "description": [ "\nA high-level summary of the service status." @@ -15162,208 +18809,228 @@ "source": { "path": "src/core/server/status/types.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ServiceStatus.detail", "type": "string", + "tags": [], "label": "detail", "description": [ "\nA more detailed description of the service status." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/status/types.ts", "lineNumber": 32 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ServiceStatus.documentationUrl", "type": "string", + "tags": [], "label": "documentationUrl", "description": [ "\nA URL to open in a new tab about how to resolve or troubleshoot the problem." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/status/types.ts", "lineNumber": 36 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ServiceStatus.meta", "type": "Uncategorized", + "tags": [], "label": "meta", "description": [ "\nAny JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained,\nmachine-readable information about the service status. May include status information for underlying features." ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "src/core/server/status/types.ts", "lineNumber": 41 }, - "signature": [ - "Meta | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ShardsInfo", "type": "Interface", + "tags": [], "label": "ShardsInfo", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.ShardsInfo.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 62 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ShardsInfo.successful", "type": "number", + "tags": [], "label": "successful", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 63 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ShardsInfo.skipped", "type": "number", + "tags": [], "label": "skipped", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 64 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ShardsInfo.failed", "type": "number", + "tags": [], "label": "failed", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 65 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 61 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ShardsResponse", "type": "Interface", + "tags": [], "label": "ShardsResponse", "description": [ "\nAll response typings are maintained until elasticsearch-js provides them out of the box\nhttps://github.com/elastic/elasticsearch-js/pull/970\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.ShardsResponse.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 43 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ShardsResponse.successful", "type": "number", + "tags": [], "label": "successful", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 44 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ShardsResponse.failed", "type": "number", + "tags": [], "label": "failed", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 45 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ShardsResponse.skipped", "type": "number", + "tags": [], "label": "skipped", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 46 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 42 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.StatusServiceSetup", "type": "Interface", + "tags": [], "label": "StatusServiceSetup", "description": [ "\nAPI for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 177 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.StatusServiceSetup.core$", "type": "Object", + "tags": [], "label": "core$", "description": [ "\nCurrent status for all Core services." ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 181 - }, "signature": [ "Observable", "<", @@ -15375,20 +19042,22 @@ "text": "CoreStatus" }, ">" - ] + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 181 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.StatusServiceSetup.overall$", "type": "Object", + "tags": [], "label": "overall$", "description": [ "\nOverall system status for all of Kibana.\n" ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 192 - }, "signature": [ "Observable", "<", @@ -15400,12 +19069,22 @@ "text": "ServiceStatus" }, ">" - ] + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 192 + }, + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.StatusServiceSetup.set", "type": "Function", + "tags": [], "label": "set", + "description": [ + "\nAllows a plugin to specify a custom status dependent on its own criteria.\nCompletely overrides the default inherited status.\n" + ], "signature": [ "(status$: ", "Observable", @@ -15419,15 +19098,19 @@ }, ">) => void" ], - "description": [ - "\nAllows a plugin to specify a custom status dependent on its own criteria.\nCompletely overrides the default inherited status.\n" - ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 202 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.StatusServiceSetup.set.$1", "type": "Object", + "tags": [], "label": "status$", - "isRequired": true, + "description": [], "signature": [ "Observable", "<", @@ -15440,32 +19123,25 @@ }, ">" ], - "description": [], "source": { "path": "src/core/server/status/types.ts", "lineNumber": 202 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 202 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.StatusServiceSetup.dependencies$", "type": "Object", + "tags": [], "label": "dependencies$", "description": [ "\nCurrent status for all plugins this plugin depends on.\nEach key of the `Record` is a plugin id." ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 208 - }, "signature": [ "Observable", ">>" - ] + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 208 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.StatusServiceSetup.derivedStatus$", "type": "Object", + "tags": [], "label": "derivedStatus$", "description": [ "\nThe status of this plugin as derived from its dependencies.\n" ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 220 - }, "signature": [ "Observable", "<", @@ -15502,332 +19180,368 @@ "text": "ServiceStatus" }, ">" - ] + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 220 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.StatusServiceSetup.isStatusPageAnonymous", "type": "Function", + "tags": [], "label": "isStatusPageAnonymous", "description": [ "\nWhether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is\npresent." ], + "signature": [ + "() => boolean" + ], "source": { "path": "src/core/server/status/types.ts", "lineNumber": 226 }, - "signature": [ - "() => boolean" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 177 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.StringValidationRegex", "type": "Interface", + "tags": [], "label": "StringValidationRegex", "description": [ "\nStringValidation with regex object" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 114 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.StringValidationRegex.regex", "type": "Object", + "tags": [], "label": "regex", "description": [], + "signature": [ + "RegExp" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 115 }, - "signature": [ - "RegExp" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.StringValidationRegex.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 116 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 114 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.StringValidationRegexString", "type": "Interface", + "tags": [], "label": "StringValidationRegexString", "description": [ "\nStringValidation as regex string" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 123 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.StringValidationRegexString.regexString", "type": "string", + "tags": [], "label": "regexString", "description": [], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 124 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.StringValidationRegexString.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 125 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 123 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.UiSettingsParams", "type": "Interface", + "tags": [], "label": "UiSettingsParams", - "signature": [ - "UiSettingsParams", - "" - ], "description": [ "\nUiSettings parameters defined by the plugins." ], - "tags": [ - "public" + "signature": [ + "UiSettingsParams", + "" ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.name", "type": "string", + "tags": [], "label": "name", "description": [ "title in the UI" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 45 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.value", "type": "Uncategorized", + "tags": [], "label": "value", "description": [ "default value to fall back to if a user doesn't provide any" ], + "signature": [ + "T | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 47 }, - "signature": [ - "T | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.description", "type": "string", + "tags": [], "label": "description", "description": [ "description provided to a user in UI" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 49 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.category", "type": "Array", + "tags": [], "label": "category", "description": [ "used to group the configured setting in the UI" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 51 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.options", "type": "Array", + "tags": [], "label": "options", "description": [ "array of permitted values for this setting" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 53 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.optionLabels", "type": "Object", + "tags": [], "label": "optionLabels", "description": [ "text labels for 'select' type UI element" ], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 55 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.requiresPageReload", "type": "CompoundType", + "tags": [], "label": "requiresPageReload", "description": [ "a flag indicating whether new value applying requires page reloading" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 57 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.readonly", "type": "CompoundType", + "tags": [], "label": "readonly", "description": [ "a flag indicating that value cannot be changed" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 59 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.sensitive", "type": "CompoundType", + "tags": [], "label": "sensitive", "description": [ "\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 64 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [ "defines a type of UI element {@link UiSettingsType}" ], + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 66 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.deprecation", "type": "Object", + "tags": [], "label": "deprecation", "description": [ "optional deprecation information. Used to generate a deprecation warning." ], + "signature": [ + "DeprecationSettings", + " | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 68 }, - "signature": [ - "DeprecationSettings", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.order", "type": "number", + "tags": [], "label": "order", "description": [ "\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n" ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 75 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.validation", "type": "CompoundType", + "tags": [], "label": "validation", "description": [], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 81 - }, "signature": [ "ImageValidation", " | ", @@ -15835,116 +19549,144 @@ " | ", "StringValidationRegexString", " | undefined" - ] + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 81 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UiSettingsParams.schema", "type": "Object", + "tags": [], "label": "schema", "description": [], + "signature": [ + "Type", + "" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 86 }, - "signature": [ - "Type", - "" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.UiSettingsParams.metric", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-server.UiSettingsParams.metric", - "type": "Object", "label": "metric", "description": [ "\nMetric to track once this property changes" ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 92 - }, "signature": [ "{ type: ", "UiCounterMetricType", "; name: string; } | undefined" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 92 + }, + "deprecated": true, + "references": [ + { + "plugin": "advancedSettings", + "link": { + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", + "lineNumber": 69 + } + } ] } ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 43 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.UiSettingsServiceSetup", "type": "Interface", + "tags": [], "label": "UiSettingsServiceSetup", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 84 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.UiSettingsServiceSetup.register", "type": "Function", + "tags": [], "label": "register", + "description": [ + "\nSets settings with default values for the uiSettings." + ], "signature": [ "(settings: Record>) => void" ], - "description": [ - "\nSets settings with default values for the uiSettings." - ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 102 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.UiSettingsServiceSetup.register.$1", "type": "Object", + "tags": [], "label": "settings", - "isRequired": true, + "description": [], "signature": [ "Record>" ], - "description": [], "source": { "path": "src/core/server/ui_settings/types.ts", "lineNumber": 102 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 102 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 84 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.UiSettingsServiceStart", "type": "Interface", + "tags": [], "label": "UiSettingsServiceStart", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 106 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.UiSettingsServiceStart.asScopedToClient", "type": "Function", + "tags": [], "label": "asScopedToClient", + "description": [ + "\nCreates a {@link IUiSettingsClient} with provided *scoped* saved objects client.\n\nThis should only be used in the specific case where the client needs to be accessed\nfrom outside of the scope of a {@link RequestHandler}.\n" + ], "signature": [ "(savedObjectsClient: Pick<", { @@ -15963,15 +19705,19 @@ "text": "IUiSettingsClient" } ], - "description": [ - "\nCreates a {@link IUiSettingsClient} with provided *scoped* saved objects client.\n\nThis should only be used in the specific case where the client needs to be accessed\nfrom outside of the scope of a {@link RequestHandler}.\n" - ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 121 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.UiSettingsServiceStart.asScopedToClient.$1", "type": "Object", + "tags": [], "label": "savedObjectsClient", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -15983,113 +19729,123 @@ }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], - "description": [], "source": { "path": "src/core/server/ui_settings/types.ts", "lineNumber": 121 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 121 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 106 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.UserProvidedValues", "type": "Interface", + "tags": [], "label": "UserProvidedValues", - "signature": [ - "UserProvidedValues", - "" - ], "description": [ "\nDescribes the values explicitly set by user." ], - "tags": [ - "public" + "signature": [ + "UserProvidedValues", + "" ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 142 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.UserProvidedValues.userValue", "type": "Uncategorized", + "tags": [], "label": "userValue", "description": [], + "signature": [ + "T | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 143 }, - "signature": [ - "T | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.UserProvidedValues.isOverridden", "type": "CompoundType", + "tags": [], "label": "isOverridden", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 144 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 142 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "core", "id": "def-server.AddConfigDeprecation", "type": "Type", + "tags": [], "label": "AddConfigDeprecation", - "tags": [ - "public" - ], "description": [ "\nConfig deprecation hook used when invoking a {@link ConfigDeprecation}\n" ], + "signature": [ + "(details: ", + "DeprecatedConfigDetails", + ") => void" + ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "lineNumber": 6 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.APP_WRAPPER_CLASS", + "type": "string", + "tags": [], + "label": "APP_WRAPPER_CLASS", + "description": [ + "\nThe class name for top level *and* nested application wrappers to ensure proper layout" + ], "signature": [ - "(details: ", - "DeprecatedConfigDetails", - ") => void" + "\"kbnAppWrapper\"" ], + "source": { + "path": "src/core/utils/app_wrapper_class.ts", + "lineNumber": 13 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.AppenderConfigType", "type": "Type", + "tags": [], "label": "AppenderConfigType", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/core/server/logging/appenders/appenders.ts", - "lineNumber": 41 - }, "signature": [ "ConsoleAppenderConfig", " | ", @@ -16101,43 +19857,43 @@ " | ", "RollingFileAppenderConfig" ], + "source": { + "path": "src/core/server/logging/appenders/appenders.ts", + "lineNumber": 41 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.CapabilitiesProvider", "type": "Type", + "tags": [], "label": "CapabilitiesProvider", - "tags": [ - "public" - ], "description": [ "\nSee {@link CapabilitiesSetup}" ], - "source": { - "path": "src/core/server/capabilities/types.ts", - "lineNumber": 18 - }, "signature": [ "() => Partial<", "Capabilities", ">" ], + "source": { + "path": "src/core/server/capabilities/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.CapabilitiesSwitcher", "type": "Type", + "tags": [], "label": "CapabilitiesSwitcher", - "tags": [ - "public" - ], "description": [ "\nSee {@link CapabilitiesSetup}" ], - "source": { - "path": "src/core/server/capabilities/types.ts", - "lineNumber": 24 - }, "signature": [ "(request: ", { @@ -16155,43 +19911,43 @@ "Capabilities", ">>" ], + "source": { + "path": "src/core/server/capabilities/types.ts", + "lineNumber": 24 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ConfigDeprecation", "type": "Type", + "tags": [], "label": "ConfigDeprecation", - "tags": [ - "public" - ], "description": [ "\nConfiguration deprecation returned from {@link ConfigDeprecationProvider} that handles a single deprecation from the configuration.\n" ], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 33 - }, "signature": [ "(config: Record, fromPath: string, addDeprecation: ", "AddConfigDeprecation", ") => Record" ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 33 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ConfigDeprecationProvider", "type": "Type", + "tags": [], "label": "ConfigDeprecationProvider", - "tags": [ - "public" - ], "description": [ "\nA provider that should returns a list of {@link ConfigDeprecation}.\n\nSee {@link ConfigDeprecationFactory} for more usage examples.\n" ], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 50 - }, "signature": [ "(factory: ", "ConfigDeprecationFactory", @@ -16199,135 +19955,223 @@ "ConfigDeprecation", "[]" ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 50 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ConfigPath", "type": "Type", + "tags": [], "label": "ConfigPath", - "tags": [ - "public" - ], "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "node_modules/@kbn/config/target/config.d.ts", "lineNumber": 2 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.Ecs", + "type": "Type", + "tags": [], + "label": "Ecs", + "description": [ + "\nRepresents the full ECS schema.\n" + ], + "signature": [ + "EcsBase & EcsTracing & { ecs: EcsField; agent?: EcsAgent | undefined; as?: EcsAutonomousSystem | undefined; client?: EcsClient | undefined; cloud?: EcsCloud | undefined; container?: EcsContainer | undefined; destination?: EcsDestination | undefined; dns?: EcsDns | undefined; error?: EcsError | undefined; event?: EcsEvent | undefined; file?: EcsFile | undefined; group?: EcsGroup | undefined; host?: EcsHost | undefined; http?: EcsHttp | undefined; log?: EcsLog | undefined; network?: EcsNetwork | undefined; observer?: EcsObserver | undefined; organization?: EcsOrganization | undefined; package?: EcsPackage | undefined; process?: EcsProcess | undefined; registry?: EcsRegistry | undefined; related?: EcsRelated | undefined; rule?: EcsRule | undefined; server?: EcsServer | undefined; service?: EcsService | undefined; source?: EcsSource | undefined; threat?: EcsThreat | undefined; tls?: EcsTls | undefined; url?: EcsUrl | undefined; user?: EcsUser | undefined; user_agent?: EcsUserAgent | undefined; vulnerability?: EcsVulnerability | undefined; }" + ], + "source": { + "path": "node_modules/@kbn/logging/target/ecs/index.d.ts", + "lineNumber": 50 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.EcsEventCategory", + "type": "Type", + "tags": [], + "label": "EcsEventCategory", + "description": [], "signature": [ - "string | string[]" + "\"host\" | \"authentication\" | \"database\" | \"package\" | \"session\" | \"network\" | \"file\" | \"process\" | \"registry\" | \"web\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" + ], + "source": { + "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", + "lineNumber": 36 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.EcsEventKind", + "type": "Type", + "tags": [], + "label": "EcsEventKind", + "description": [], + "signature": [ + "\"alert\" | \"event\" | \"state\" | \"metric\" | \"signal\" | \"pipeline_error\"" + ], + "source": { + "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", + "lineNumber": 40 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.EcsEventOutcome", + "type": "Type", + "tags": [], + "label": "EcsEventOutcome", + "description": [], + "signature": [ + "\"success\" | \"failure\" | \"unknown\"" + ], + "source": { + "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", + "lineNumber": 44 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.EcsEventType", + "type": "Type", + "tags": [], + "label": "EcsEventType", + "description": [], + "signature": [ + "\"start\" | \"connection\" | \"end\" | \"user\" | \"info\" | \"error\" | \"group\" | \"protocol\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], + "source": { + "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", + "lineNumber": 48 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ElasticsearchClient", "type": "Type", + "tags": [], "label": "ElasticsearchClient", - "tags": [ - "public" - ], "description": [ "\nClient used to query the elasticsearch cluster.\n" ], + "signature": [ + "Pick & { transport: { request(params: TransportRequestParams, options?: TransportRequestOptions | undefined): TransportRequestPromise; }; }" + ], "source": { "path": "src/core/server/elasticsearch/client/types.ts", "lineNumber": 22 }, - "signature": [ - "Pick & { transport: { request(params: TransportRequestParams, options?: TransportRequestOptions | undefined): TransportRequestPromise; }; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ElasticsearchClientConfig", "type": "Type", + "tags": [], "label": "ElasticsearchClientConfig", - "tags": [ - "public" - ], "description": [ "\nConfiguration options to be used to create a {@link IClusterClient | cluster client} using the\n{@link ElasticsearchServiceStart.createClient | createClient API}\n" ], + "signature": [ + "Pick & { pingTimeout?: ElasticsearchConfig['pingTimeout'] | ClientOptions['pingTimeout']; requestTimeout?: ElasticsearchConfig['requestTimeout'] | ClientOptions['requestTimeout']; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; }" + ], "source": { "path": "src/core/server/elasticsearch/client/client_config.ts", "lineNumber": 22 }, - "signature": [ - "Pick & { pingTimeout?: ElasticsearchConfig['pingTimeout'] | ClientOptions['pingTimeout']; requestTimeout?: ElasticsearchConfig['requestTimeout'] | ClientOptions['requestTimeout']; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HandlerContextType", "type": "Type", + "tags": [], "label": "HandlerContextType", - "tags": [ - "public" - ], "description": [ "\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n" ], + "signature": [ + "T extends HandlerFunction ? U : never" + ], "source": { "path": "src/core/server/context/container/context.ts", "lineNumber": 49 }, - "signature": [ - "T extends HandlerFunction ? U : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HandlerFunction", "type": "Type", + "tags": [], "label": "HandlerFunction", - "tags": [ - "public" - ], "description": [ "\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n" ], + "signature": [ + "(context: T, args: any[]) => any" + ], "source": { "path": "src/core/server/context/container/context.ts", "lineNumber": 42 }, - "signature": [ - "(context: T, args: any[]) => any" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HandlerParameters", "type": "Type", + "tags": [], "label": "HandlerParameters", - "tags": [ - "public" - ], "description": [ "\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n" ], + "signature": [ + "T extends (context: any, ...args: infer U) => any ? U : never" + ], "source": { "path": "src/core/server/context/container/context.ts", "lineNumber": 59 }, - "signature": [ - "T extends (context: any, ...args: infer U) => any ? U : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HttpResourcesRequestHandler", "type": "Type", - "label": "HttpResourcesRequestHandler", "tags": [ - "libk", - "public" + "libk" ], + "label": "HttpResourcesRequestHandler", "description": [ "\nExtended version of {@link RequestHandler} having access to {@link HttpResourcesServiceToolkit}\nto respond with HTML or JS resources." ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 76 - }, "signature": [ "(context: Context, request: ", { @@ -16358,41 +20202,41 @@ "text": "ErrorHttpResponseOptions" } ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 76 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HttpResourcesResponseOptions", "type": "Type", + "tags": [], "label": "HttpResourcesResponseOptions", - "tags": [ - "public" - ], "description": [ "\nHTTP Resources response parameters" ], + "signature": [ + "HttpResponseOptions" + ], "source": { "path": "src/core/server/http_resources/types.ts", "lineNumber": 37 }, - "signature": [ - "HttpResponseOptions" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.IContextProvider", "type": "Type", + "tags": [], "label": "IContextProvider", - "tags": [ - "public" - ], "description": [ "\nA function that returns a context value for a specific key of given context type.\n" ], - "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 27 - }, "signature": [ "(context: Pick>, rest: [request: ", { @@ -16423,25 +20267,325 @@ "text": "ErrorHttpResponseOptions" } ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 27 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ILegacyClusterClient", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "ILegacyClusterClient", + "description": [ + "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n\nSee {@link LegacyClusterClient}.\n" + ], + "signature": [ + "{ callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, + " | undefined) => Pick; }" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 83 + }, + "deprecated": true, + "references": [ + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/types.ts", + "lineNumber": 9 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/types.ts", + "lineNumber": 85 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/types.ts", + "lineNumber": 110 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 18 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 109 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 151 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 180 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 9 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 57 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 80 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 9 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 52 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 74 + } + }, + { + "plugin": "beatsManagement", + "link": { + "path": "x-pack/plugins/beats_management/server/lib/adapters/database/kibana_database_adapter.ts", + "lineNumber": 8 + } + }, + { + "plugin": "beatsManagement", + "link": { + "path": "x-pack/plugins/beats_management/server/lib/adapters/database/kibana_database_adapter.ts", + "lineNumber": 28 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 18 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.test.ts", + "lineNumber": 33 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/types.ts", + "lineNumber": 11 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/types.ts", + "lineNumber": 90 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_usage_collector.ts", + "lineNumber": 9 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_usage_collector.ts", + "lineNumber": 22 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/index.ts", + "lineNumber": 8 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/index.ts", + "lineNumber": 19 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/register_monitoring_telemetry_collection.ts", + "lineNumber": 8 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/register_monitoring_telemetry_collection.ts", + "lineNumber": 34 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/target/types/server/types.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/target/types/server/types.d.ts", + "lineNumber": 70 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/target/types/server/types.d.ts", + "lineNumber": 94 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/types.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/types.d.ts", + "lineNumber": 61 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/index.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/index.d.ts", + "lineNumber": 5 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/register_monitoring_telemetry_collection.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/register_monitoring_telemetry_collection.d.ts", + "lineNumber": 3 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/get_usage_collector.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/get_usage_collector.d.ts", + "lineNumber": 5 + } + } + ], "initialIsOpen": false }, { - "id": "def-server.ILegacyClusterClient", + "parentPluginId": "core", + "id": "def-server.ILegacyCustomClusterClient", "type": "Type", - "label": "ILegacyClusterClient", "tags": [ - "deprecated", - "public" + "deprecated" ], + "label": "ILegacyCustomClusterClient", "description": [ - "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n\nSee {@link LegacyClusterClient}.\n" + "\nRepresents an Elasticsearch cluster API client created by a plugin.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n\nSee {@link LegacyClusterClient}." ], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 83 - }, "signature": [ - "{ callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", + "{ close: () => void; callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", { "pluginId": "core", "scope": "server", @@ -16467,198 +20611,651 @@ }, " | undefined) => Pick; }" ], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 94 + }, + "deprecated": true, + "references": [ + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/plugin.ts", + "lineNumber": 14 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/plugin.ts", + "lineNumber": 42 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts", + "lineNumber": 13 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts", + "lineNumber": 69 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/types.ts", + "lineNumber": 13 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/types.ts", + "lineNumber": 74 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/es_client/instantiate_client.ts", + "lineNumber": 9 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/es_client/instantiate_client.ts", + "lineNumber": 29 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/license_service.ts", + "lineNumber": 9 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/license_service.ts", + "lineNumber": 18 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/static_globals.ts", + "lineNumber": 8 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/static_globals.ts", + "lineNumber": 18 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/static_globals.ts", + "lineNumber": 43 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/plugin.ts", + "lineNumber": 18 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/plugin.ts", + "lineNumber": 74 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/plugin.ts", + "lineNumber": 279 + } + }, + { + "plugin": "rollup", + "link": { + "path": "x-pack/plugins/rollup/server/plugin.ts", + "lineNumber": 12 + } + }, + { + "plugin": "rollup", + "link": { + "path": "x-pack/plugins/rollup/server/plugin.ts", + "lineNumber": 36 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/types.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/types.d.ts", + "lineNumber": 47 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/plugin.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/plugin.d.ts", + "lineNumber": 29 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/license_service.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/license_service.d.ts", + "lineNumber": 8 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/static_globals.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/static_globals.d.ts", + "lineNumber": 8 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/static_globals.d.ts", + "lineNumber": 15 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/es_client/instantiate_client.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/es_client/instantiate_client.d.ts", + "lineNumber": 5 + } + } + ], "initialIsOpen": false }, { - "id": "def-server.ILegacyCustomClusterClient", + "parentPluginId": "core", + "id": "def-server.ILegacyScopedClusterClient", "type": "Type", - "label": "ILegacyCustomClusterClient", "tags": [ - "deprecated", - "public" + "deprecated" ], + "label": "ILegacyScopedClusterClient", "description": [ - "\nRepresents an Elasticsearch cluster API client created by a plugin.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n\nSee {@link LegacyClusterClient}." + "\nServes the same purpose as \"normal\" `ClusterClient` but exposes additional\n`callAsCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `callAsInternalUser` does) to request Elasticsearch API, but rather\npasses HTTP headers extracted from the current user request to the API.\n\nSee {@link LegacyScopedClusterClient}.\n" + ], + "signature": [ + "{ callAsCurrentUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; callAsInternalUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; }" ], "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 94 + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 24 }, - "signature": [ - "{ close: () => void; callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", + "deprecated": true, + "references": [ + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 19 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 102 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 103 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 111 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 114 + } + }, + { + "plugin": "licensing", + "link": { + "path": "x-pack/plugins/licensing/server/plugin.ts", + "lineNumber": 115 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/policy/service.ts", + "lineNumber": 11 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/policy/service.ts", + "lineNumber": 52 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/mocks.ts", + "lineNumber": 8 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/mocks.ts", + "lineNumber": 135 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 10 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts", + "lineNumber": 58 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 10 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts", + "lineNumber": 53 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/policy/handlers.test.ts", + "lineNumber": 16 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/endpoint/routes/policy/handlers.test.ts", + "lineNumber": 36 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 10 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 43 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 50 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/types.ts", + "lineNumber": 8 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/server/types.ts", + "lineNumber": 41 + } + }, + { + "plugin": "globalSearch", + "link": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 11 + } + }, + { + "plugin": "globalSearch", + "link": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 73 + } + }, + { + "plugin": "infra", + "link": { + "path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts", + "lineNumber": 9 + } + }, + { + "plugin": "infra", + "link": { + "path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts", + "lineNumber": 139 + } + }, + { + "plugin": "infra", + "link": { + "path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts", + "lineNumber": 405 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/target/types/server/types.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "crossClusterReplication", + "link": { + "path": "x-pack/plugins/cross_cluster_replication/target/types/server/types.d.ts", + "lineNumber": 30 + } + }, + { + "plugin": "globalSearch", + "link": { + "path": "x-pack/plugins/global_search/target/types/server/types.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "globalSearch", + "link": { + "path": "x-pack/plugins/global_search/target/types/server/types.d.ts", + "lineNumber": 45 + } + }, + { + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/target/types/server/types.d.ts", + "lineNumber": 1 + } + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/target/types/server/types.d.ts", + "lineNumber": 27 + } }, - " | ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.LegacyRequest", - "text": "LegacyRequest" + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/target/types/server/types.d.ts", + "lineNumber": 33 + } }, - " | ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FakeRequest", - "text": "FakeRequest" + "plugin": "infra", + "link": { + "path": "x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts", + "lineNumber": 1 + } }, - " | undefined) => Pick; }" - ], - "initialIsOpen": false - }, - { - "id": "def-server.ILegacyScopedClusterClient", - "type": "Type", - "label": "ILegacyScopedClusterClient", - "tags": [ - "deprecated", - "public" - ], - "description": [ - "\nServes the same purpose as \"normal\" `ClusterClient` but exposes additional\n`callAsCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `callAsInternalUser` does) to request Elasticsearch API, but rather\npasses HTTP headers extracted from the current user request to the API.\n\nSee {@link LegacyScopedClusterClient}.\n" - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 24 - }, - "signature": [ - "{ callAsCurrentUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; callAsInternalUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; }" + { + "plugin": "infra", + "link": { + "path": "x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts", + "lineNumber": 58 + } + } ], "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LegacyElasticsearchClientConfig", "type": "Type", - "label": "LegacyElasticsearchClientConfig", "tags": [ "privateRemarks", - "deprecated", - "public" + "deprecated" ], + "label": "LegacyElasticsearchClientConfig", "description": [], + "signature": [ + "Pick & Pick & { pingTimeout?: ElasticsearchConfig['pingTimeout'] | ConfigOptions['pingTimeout']; requestTimeout?: ElasticsearchConfig['requestTimeout'] | ConfigOptions['requestTimeout']; sniffInterval?: ElasticsearchConfig['sniffInterval'] | ConfigOptions['sniffInterval']; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; }" + ], "source": { "path": "src/core/server/elasticsearch/legacy/elasticsearch_client_config.ts", "lineNumber": 27 }, - "signature": [ - "Pick & Pick & { pingTimeout?: ElasticsearchConfig['pingTimeout'] | ConfigOptions['pingTimeout']; requestTimeout?: ElasticsearchConfig['requestTimeout'] | ConfigOptions['requestTimeout']; sniffInterval?: ElasticsearchConfig['sniffInterval'] | ConfigOptions['sniffInterval']; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; }" - ], + "deprecated": true, + "references": [], "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LoggerConfigType", "type": "Type", + "tags": [], "label": "LoggerConfigType", - "tags": [ - "public" - ], "description": [], + "signature": [ + "{ readonly name: string; readonly level: ", + "LogLevelId", + "; readonly appenders: string[]; }" + ], "source": { "path": "src/core/server/logging/logging_config.ts", "lineNumber": 60 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.LogMeta", + "type": "Type", + "tags": [], + "label": "LogMeta", + "description": [ + "\nRepresents the ECS schema with the following reserved keys excluded:\n- `ecs`\n- `@timestamp`\n- `message`\n- `log.level`\n- `log.logger`\n" + ], "signature": [ - "{ readonly name: string; readonly level: ", - "LogLevelId", - "; readonly appenders: string[]; }" + "Pick & EcsTracing & { agent?: EcsAgent | undefined; as?: EcsAutonomousSystem | undefined; client?: EcsClient | undefined; cloud?: EcsCloud | undefined; container?: EcsContainer | undefined; destination?: EcsDestination | undefined; dns?: EcsDns | undefined; error?: EcsError | undefined; event?: EcsEvent | undefined; file?: EcsFile | undefined; group?: EcsGroup | undefined; host?: EcsHost | undefined; http?: EcsHttp | undefined; log?: Pick | undefined; network?: EcsNetwork | undefined; observer?: EcsObserver | undefined; organization?: EcsOrganization | undefined; package?: EcsPackage | undefined; process?: EcsProcess | undefined; registry?: EcsRegistry | undefined; related?: EcsRelated | undefined; rule?: EcsRule | undefined; server?: EcsServer | undefined; service?: EcsService | undefined; source?: EcsSource | undefined; threat?: EcsThreat | undefined; tls?: EcsTls | undefined; url?: EcsUrl | undefined; user?: EcsUser | undefined; user_agent?: EcsUserAgent | undefined; vulnerability?: EcsVulnerability | undefined; }" + ], + "source": { + "path": "node_modules/@kbn/logging/target/log_meta.d.ts", + "lineNumber": 44 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.MakeUsageFromSchema", + "type": "Type", + "tags": [], + "label": "MakeUsageFromSchema", + "description": [ + "\nList of configuration values that will be exposed to usage collection.\nIf parent node or actual config path is set to `true` then the actual value\nof these configs will be reoprted.\nIf parent node or actual config path is set to `false` then the config\nwill be reported as [redacted].\n" + ], + "signature": [ + "{ [Key in keyof T]?: (T[Key] extends Maybe ? false : T[Key] extends any[] | undefined ? boolean : T[Key] extends object | undefined ? boolean | MakeUsageFromSchema : boolean) | undefined; }" ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 97 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.MetricsServiceStart", "type": "Type", + "tags": [], "label": "MetricsServiceStart", - "tags": [ - "public" - ], "description": [ "\n{@inheritdoc MetricsServiceSetup}\n" ], + "signature": [ + "MetricsServiceSetup" + ], "source": { "path": "src/core/server/metrics/types.ts", "lineNumber": 40 }, - "signature": [ - "MetricsServiceSetup" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.MIGRATION_ASSISTANCE_INDEX_ACTION", "type": "Type", - "label": "MIGRATION_ASSISTANCE_INDEX_ACTION", "tags": [ - "deprecated", - "public" + "deprecated" ], + "label": "MIGRATION_ASSISTANCE_INDEX_ACTION", "description": [], + "signature": [ + "\"upgrade\" | \"reindex\"" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 326 }, - "signature": [ - "\"upgrade\" | \"reindex\"" - ], + "deprecated": true, + "references": [], "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.MIGRATION_DEPRECATION_LEVEL", "type": "Type", - "label": "MIGRATION_DEPRECATION_LEVEL", "tags": [ - "deprecated", - "public" + "deprecated" ], + "label": "MIGRATION_DEPRECATION_LEVEL", "description": [], + "signature": [ + "\"warning\" | \"none\" | \"info\" | \"critical\"" + ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", "lineNumber": 331 }, - "signature": [ - "\"warning\" | \"none\" | \"info\" | \"critical\"" - ], + "deprecated": true, + "references": [], "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PluginConfigSchema", "type": "Type", + "tags": [], "label": "PluginConfigSchema", - "tags": [ - "public" - ], "description": [ "\nDedicated type for plugin configuration schema.\n" ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 26 - }, "signature": [ "Type" ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 28 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PluginInitializer", "type": "Type", + "tags": [], "label": "PluginInitializer", - "tags": [ - "public" - ], "description": [ "\nThe `plugin` export at the root of a plugin's `server` directory should conform\nto this interface.\n" ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 411 - }, "signature": [ "(core: ", { @@ -16686,77 +21283,77 @@ }, "" ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 444 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PluginName", "type": "Type", + "tags": [], "label": "PluginName", - "tags": [ - "public" - ], "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" ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 81 - }, "signature": [ "string" ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 114 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PluginOpaqueId", "type": "Type", + "tags": [], "label": "PluginOpaqueId", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 84 - }, "signature": [ "symbol" ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 117 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PublicUiSettingsParams", "type": "Type", + "tags": [], "label": "PublicUiSettingsParams", - "tags": [ - "public" - ], "description": [ "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." ], + "signature": [ + "{ type?: \"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined; options?: string[] | undefined; description?: string | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; category?: string[] | undefined; metric?: { type: UiCounterMetricType; name: string; } | undefined; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; }" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 102 }, - "signature": [ - "{ type?: \"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined; options?: string[] | undefined; description?: string | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; category?: string[] | undefined; metric?: { type: UiCounterMetricType; name: string; } | undefined; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectAttribute", "type": "Type", + "tags": [], "label": "SavedObjectAttribute", - "tags": [ - "public" - ], "description": [ "\nType definition for a Saved Object attribute value\n" ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 27 - }, "signature": [ "undefined | null | string | number | false | true | ", "SavedObjectAttributes", @@ -16764,42 +21361,42 @@ "SavedObjectAttributeSingle", "[]" ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 27 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectAttributeSingle", "type": "Type", + "tags": [], "label": "SavedObjectAttributeSingle", - "tags": [ - "public" - ], "description": [ "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 14 - }, "signature": [ "undefined | null | string | number | false | true | ", "SavedObjectAttributes" ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 14 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ScopeableRequest", "type": "Type", + "tags": [], "label": "ScopeableRequest", - "tags": [ - "public" - ], "description": [ "\n A user credentials container.\nIt accommodates the necessary auth credentials to impersonate the current user.\n" ], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 192 - }, "signature": [ { "pluginId": "core", @@ -16825,39 +21422,39 @@ "text": "FakeRequest" } ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 192 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ServiceStatusLevel", "type": "Type", + "tags": [], "label": "ServiceStatusLevel", - "tags": [ - "public" - ], "description": [ "\nA convenience type that represents the union of each value in {@link ServiceStatusLevels}." ], + "signature": [ + "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" + ], "source": { "path": "src/core/server/status/types.ts", "lineNumber": 103 }, - "signature": [ - "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SharedGlobalConfig", "type": "Type", + "tags": [], "label": "SharedGlobalConfig", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 292 - }, "signature": [ "{ readonly kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => ", "Duration", @@ -16870,22 +21467,22 @@ "; as: (units: ", "unitOfTime" ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 325 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.StartServicesAccessor", "type": "Type", + "tags": [], "label": "StartServicesAccessor", - "tags": [ - "public" - ], "description": [ "\nAllows plugins to get access to APIs available in start inside async handlers.\nPromise will not resolve until Core and plugin dependencies have completed `start`.\nThis should only be used inside handlers registered during `setup` that will only be executed\nafter `start` lifecycle.\n" ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 502 - }, "signature": [ "() => Promise<[", { @@ -16897,67 +21494,72 @@ }, ", TPluginsStart, TStart]>" ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 510 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.StringValidation", "type": "Type", + "tags": [], "label": "StringValidation", - "tags": [ - "public" - ], "description": [ "\nAllows regex objects or a regex string" ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 108 - }, "signature": [ "StringValidationRegex", " | ", "StringValidationRegexString" ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 108 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.UiSettingsType", "type": "Type", + "tags": [], "label": "UiSettingsType", - "tags": [ - "public" - ], "description": [ "\nUI element type to represent the settings." ], + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\"" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 16 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [ - "public" - ], + "parentPluginId": "core", "id": "def-server.ServiceStatusLevels", "type": "Object", + "tags": [], "label": "ServiceStatusLevels", "description": [ "\nThe current \"level\" of availability of a service.\n" ], + "signature": [ + "Readonly<{ available: Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>; degraded: Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }>; unavailable: Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }>; critical: Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>; }>" + ], "source": { "path": "src/core/server/status/types.ts", "lineNumber": 56 }, - "signature": [ - "Readonly<{ available: Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>; degraded: Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }>; unavailable: Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }>; critical: Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>; }>" - ], + "deprecated": false, "initialIsOpen": false } ] diff --git a/api_docs/core_application.json b/api_docs/core_application.json index 0c9ae36b4cc96..d1b76aa645bf7 100644 --- a/api_docs/core_application.json +++ b/api_docs/core_application.json @@ -3,11 +3,10 @@ "client": { "classes": [ { + "parentPluginId": "core", "id": "def-public.ScopedHistory", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "ScopedHistory", "description": [ "\nA wrapper around a `History` instance that is scoped to a particular base path of the history stack. Behaves\nsimilarly to the `basename` option except that this wrapper hides any history stack entries from outside the scope\nof this base path.\n\nThis wrapper also allows Core and Plugins to share a single underlying global `History` instance without exposing\nthe history of other applications.\n\nThe {@link ScopedHistory.createSubHistory | createSubHistory} method is particularly useful for applications that\ncontain any number of \"sub-apps\" which should not have access to the main application's history or basePath.\n" @@ -24,71 +23,74 @@ "History", "" ], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ScopedHistory.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ScopedHistory.Unnamed.$1", "type": "Object", + "tags": [], "label": "parentHistory", - "isRequired": true, + "description": [], "signature": [ "History", "" ], - "description": [], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.Unnamed.$2", "type": "string", + "tags": [], "label": "basePath", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/application/scoped_history.ts", - "lineNumber": 59 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.createSubHistory", "type": "Function", - "children": [ - { - "id": "def-public.ScopedHistory.createSubHistory.$1", - "type": "string", - "label": "basePath", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/core/public/application/scoped_history.ts", - "lineNumber": 78 - } - } + "tags": [], + "label": "createSubHistory", + "description": [ + "\nCreates a `ScopedHistory` for a subpath of this `ScopedHistory`. Useful for applications that may have sub-apps\nthat do not need access to the containing application's history.\n" ], "signature": [ "(basePath: string) => ", @@ -101,281 +103,353 @@ }, "" ], - "description": [ - "\nCreates a `ScopedHistory` for a subpath of this `ScopedHistory`. Useful for applications that may have sub-apps\nthat do not need access to the containing application's history.\n" - ], - "label": "createSubHistory", "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 77 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.ScopedHistory.createSubHistory.$1", + "type": "string", + "tags": [], + "label": "basePath", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 78 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.length", "type": "number", - "label": "length", "tags": [], + "label": "length", "description": [ "\nThe number of entries in the history stack, including all entries forwards and backwards from the current location." ], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 86 - } + }, + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.location", "type": "Object", - "label": "location", "tags": [], + "label": "location", "description": [ "\nThe current location of the history stack." ], + "signature": [ + "Location", + "" + ], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 94 }, - "signature": [ - "Location", - "" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.action", "type": "CompoundType", - "label": "action", "tags": [], + "label": "action", "description": [ "\nThe last action dispatched on the history stack." ], + "signature": [ + "Action" + ], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 102 }, - "signature": [ - "Action" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.push", "type": "Function", + "tags": [], + "label": "push", + "description": [ + "\nPushes a new location onto the history stack. If there are forward entries in the stack, they will be removed.\n" + ], + "signature": [ + "(pathOrLocation: string | ", + "LocationDescriptorObject", + ", state?: HistoryLocationState | undefined) => void" + ], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 113 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ScopedHistory.push.$1", "type": "CompoundType", + "tags": [], "label": "pathOrLocation", - "isRequired": true, + "description": [], "signature": [ "string | ", "LocationDescriptorObject", "" ], - "description": [], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 114 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.push.$2", "type": "Uncategorized", + "tags": [], "label": "state", - "isRequired": false, + "description": [], "signature": [ "HistoryLocationState | undefined" ], - "description": [], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 115 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.ScopedHistory.replace", + "type": "Function", + "tags": [], + "label": "replace", + "description": [ + "\nReplaces the current location in the history stack. Does not remove forward or backward entries.\n" + ], "signature": [ "(pathOrLocation: string | ", "LocationDescriptorObject", ", state?: HistoryLocationState | undefined) => void" ], - "description": [ - "\nPushes a new location onto the history stack. If there are forward entries in the stack, they will be removed.\n" - ], - "label": "push", "source": { "path": "src/core/public/application/scoped_history.ts", - "lineNumber": 113 + "lineNumber": 131 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ScopedHistory.replace", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ScopedHistory.replace.$1", "type": "CompoundType", + "tags": [], "label": "pathOrLocation", - "isRequired": true, + "description": [], "signature": [ "string | ", "LocationDescriptorObject", "" ], - "description": [], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 132 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.replace.$2", "type": "Uncategorized", + "tags": [], "label": "state", - "isRequired": false, + "description": [], "signature": [ "HistoryLocationState | undefined" ], - "description": [], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 133 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(pathOrLocation: string | ", - "LocationDescriptorObject", - ", state?: HistoryLocationState | undefined) => void" - ], - "description": [ - "\nReplaces the current location in the history stack. Does not remove forward or backward entries.\n" - ], - "label": "replace", - "source": { - "path": "src/core/public/application/scoped_history.ts", - "lineNumber": 131 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.go", "type": "Function", + "tags": [], + "label": "go", + "description": [ + "\nSend the user forward or backwards in the history stack.\n" + ], + "signature": [ + "(n: number) => void" + ], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 150 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ScopedHistory.go.$1", "type": "number", + "tags": [], "label": "n", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 150 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(n: number) => void" - ], - "description": [ - "\nSend the user forward or backwards in the history stack.\n" - ], - "label": "go", - "source": { - "path": "src/core/public/application/scoped_history.ts", - "lineNumber": 150 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.goBack", "type": "Function", - "children": [], - "signature": [ - "() => void" - ], + "tags": [], + "label": "goBack", "description": [ "\nSend the user one location back in the history stack. Equivalent to calling\n{@link ScopedHistory.go | ScopedHistory.go(-1)}. If no more entries are available backwards, this is a no-op." ], - "label": "goBack", + "signature": [ + "() => void" + ], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 168 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.goForward", "type": "Function", - "children": [], - "signature": [ - "() => void" - ], + "tags": [], + "label": "goForward", "description": [ "\nSend the user one location forward in the history stack. Equivalent to calling\n{@link ScopedHistory.go | ScopedHistory.go(1)}. If no more entries are available forwards, this is a no-op." ], - "label": "goForward", + "signature": [ + "() => void" + ], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 177 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.block", "type": "Function", + "tags": [], + "label": "block", + "description": [ + "\nAdd a block prompt requesting user confirmation when navigating away from the current page." + ], + "signature": [ + "(prompt?: string | boolean | ", + "History", + ".TransitionPromptHook | undefined) => ", + "UnregisterCallback" + ], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 185 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ScopedHistory.block.$1", "type": "CompoundType", + "tags": [], "label": "prompt", - "isRequired": false, + "description": [], "signature": [ "string | boolean | ", "History", ".TransitionPromptHook | undefined" ], - "description": [], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 186 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.ScopedHistory.listen", + "type": "Function", + "tags": [], + "label": "listen", + "description": [ + "\nAdds a listener for location updates.\n" + ], "signature": [ - "(prompt?: string | boolean | ", - "History", - ".TransitionPromptHook | undefined) => ", + "(listener: (location: ", + "Location", + ", action: ", + "Action", + ") => void) => ", "UnregisterCallback" ], - "description": [ - "\nAdd a block prompt requesting user confirmation when navigating away from the current page." - ], - "label": "block", "source": { "path": "src/core/public/application/scoped_history.ts", - "lineNumber": 185 + "lineNumber": 205 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ScopedHistory.listen", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ScopedHistory.listen.$1", "type": "Function", + "tags": [], "label": "listener", - "isRequired": true, + "description": [], "signature": [ "(location: ", "Location", @@ -383,111 +457,103 @@ "Action", ") => void" ], - "description": [], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 206 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(listener: (location: ", - "Location", - ", action: ", - "Action", - ") => void) => ", - "UnregisterCallback" - ], - "description": [ - "\nAdds a listener for location updates.\n" - ], - "label": "listen", - "source": { - "path": "src/core/public/application/scoped_history.ts", - "lineNumber": 205 - }, - "tags": [], "returnComment": [ "an function to unsubscribe the listener." ] }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.createHref", "type": "Function", + "tags": [], + "label": "createHref", + "description": [ + "\nCreates an href (string) to the location.\nIf `prependBasePath` is true (default), it will prepend the location's path with the scoped history basePath.\n" + ], + "signature": [ + "(location: ", + "LocationDescriptorObject", + ", { prependBasePath }?: { prependBasePath?: boolean | undefined; }) => string" + ], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 222 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ScopedHistory.createHref.$1", "type": "Object", + "tags": [], "label": "location", - "isRequired": true, + "description": [], "signature": [ "LocationDescriptorObject", "" ], - "description": [], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 223 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ScopedHistory.createHref.$2.prependBasePathtrue", "type": "Object", - "label": "{ prependBasePath = true }", "tags": [], + "label": "{ prependBasePath = true }", "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 224 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ScopedHistory.createHref.$2.prependBasePathtrue.prependBasePath", "type": "CompoundType", + "tags": [], "label": "prependBasePath", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/application/scoped_history.ts", "lineNumber": 224 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/core/public/application/scoped_history.ts", - "lineNumber": 224 - } + ] } ], - "signature": [ - "(location: ", - "LocationDescriptorObject", - ", { prependBasePath }?: { prependBasePath?: boolean | undefined; }) => string" - ], - "description": [ - "\nCreates an href (string) to the location.\nIf `prependBasePath` is true (default), it will prepend the location's path with the scoped history basePath.\n" - ], - "label": "createHref", - "source": { - "path": "src/core/public/application/scoped_history.ts", - "lineNumber": 222 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/core/public/application/scoped_history.ts", - "lineNumber": 34 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "core", "id": "def-public.App", "type": "Interface", + "tags": [], "label": "App", + "description": [], "signature": [ { "pluginId": "core", @@ -498,15 +564,17 @@ }, "" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 79 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nThe unique identifier of the application" @@ -514,12 +582,14 @@ "source": { "path": "src/core/public/application/types.ts", "lineNumber": 83 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.title", "type": "string", + "tags": [], "label": "title", "description": [ "\nThe title of the application." @@ -527,37 +597,37 @@ "source": { "path": "src/core/public/application/types.ts", "lineNumber": 88 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.category", "type": "Object", + "tags": [], "label": "category", "description": [ "\nThe category definition of the product\nSee {@link AppCategory}\nSee DEFAULT_APP_CATEGORIES for more reference" ], + "signature": [ + "AppCategory", + " | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 95 }, - "signature": [ - "AppCategory", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.status", "type": "CompoundType", + "tags": [], "label": "status", "description": [ "\nThe initial status of the application.\nDefaulting to `accessible`" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 101 - }, "signature": [ { "pluginId": "core", @@ -567,20 +637,22 @@ "text": "AppStatus" }, " | undefined" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 101 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.navLinkStatus", "type": "CompoundType", + "tags": [], "label": "navLinkStatus", "description": [ "\nThe initial status of the application's navLink.\nDefaulting to `visible` if `status` is `accessible` and `hidden` if status is `inaccessible`\nSee {@link AppNavLinkStatus}" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 108 - }, "signature": [ { "pluginId": "core", @@ -590,36 +662,40 @@ "text": "AppNavLinkStatus" }, " | undefined" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 108 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.defaultPath", "type": "string", + "tags": [], "label": "defaultPath", "description": [ "\nAllow to define the default path a user should be directed to when navigating to the app.\nWhen defined, this value will be used as a default for the `path` option when calling {@link ApplicationStart.navigateToApp | navigateToApp}`,\nand will also be appended to the {@link ChromeNavLink | application navLink} in the navigation bar." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 115 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.updater$", "type": "Object", + "tags": [], "label": "updater$", "description": [ "\nAn {@link AppUpdater} observable that can be used to update the application {@link AppUpdatableFields} at runtime.\n" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 149 - }, "signature": [ "Observable", "<", @@ -631,118 +707,132 @@ "text": "AppUpdater" }, "> | undefined" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 149 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.order", "type": "number", + "tags": [], "label": "order", "description": [ "\nAn ordinal used to sort nav links relative to one another for display." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 154 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.tooltip", "type": "string", + "tags": [], "label": "tooltip", "description": [ "\nA tooltip shown when hovering over app link." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 159 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.euiIconType", "type": "string", + "tags": [], "label": "euiIconType", "description": [ "\nA EUI iconType that will be used for the app's icon. This icon\ntakes precendence over the `icon` property." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 165 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.icon", "type": "string", + "tags": [], "label": "icon", "description": [ "\nA URL to an image file used as an icon. Used as a fallback\nif `euiIconType` is not provided." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 171 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.capabilities", "type": "Object", + "tags": [], "label": "capabilities", "description": [ "\nCustom capabilities defined by the app." ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 176 - }, "signature": [ "Partial<", "Capabilities", "> | undefined" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 176 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.chromeless", "type": "CompoundType", + "tags": [], "label": "chromeless", "description": [ "\nHide the UI chrome when the application is mounted. Defaults to `false`.\nTakes precedence over chrome service visibility settings." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 182 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.mount", "type": "Function", + "tags": [], "label": "mount", "description": [ "\nA mount function called when the user navigates to this app's route." ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 187 - }, "signature": [ { "pluginId": "core", @@ -752,52 +842,58 @@ "text": "AppMount" }, "" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 187 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.appRoute", "type": "string", + "tags": [], "label": "appRoute", "description": [ "\nOverride the application's routing path from `/app/${id}`.\nMust be unique across registered applications. Should not include the\nbase path from HTTP." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 194 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.exactRoute", "type": "CompoundType", + "tags": [], "label": "exactRoute", "description": [ "\nIf set to true, the application's route will only be checked against an exact match. Defaults to `false`.\n" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 212 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.App.meta", "type": "Object", + "tags": [], "label": "meta", "description": [ "\nMeta data for an application that represent additional information for the app.\nSee {@link AppMeta}\n" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 244 - }, "signature": [ { "pluginId": "core", @@ -807,36 +903,38 @@ "text": "AppMeta" }, " | undefined" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 244 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 79 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppLeaveConfirmAction", "type": "Interface", + "tags": [], "label": "AppLeaveConfirmAction", "description": [ "\nAction to return from a {@link AppLeaveHandler} to show a confirmation\nmessage when trying to leave an application.\n\nSee {@link AppLeaveActionFactory}\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 565 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppLeaveConfirmAction.type", "type": "string", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 566 - }, "signature": [ { "pluginId": "core", @@ -846,75 +944,83 @@ "text": "AppLeaveActionType" }, ".confirm" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 566 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppLeaveConfirmAction.text", "type": "string", + "tags": [], "label": "text", "description": [], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 567 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppLeaveConfirmAction.title", "type": "string", + "tags": [], "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 568 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppLeaveConfirmAction.callback", "type": "Function", + "tags": [], "label": "callback", "description": [], + "signature": [ + "(() => void) | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 569 }, - "signature": [ - "(() => void) | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 565 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppLeaveDefaultAction", "type": "Interface", + "tags": [], "label": "AppLeaveDefaultAction", "description": [ "\nAction to return from a {@link AppLeaveHandler} to execute the default\nbehaviour when leaving the application.\n\nSee {@link AppLeaveActionFactory}\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 553 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppLeaveDefaultAction.type", "type": "string", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 554 - }, "signature": [ { "pluginId": "core", @@ -924,28 +1030,38 @@ "text": "AppLeaveActionType" }, ".default" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 554 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 553 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ApplicationSetup", "type": "Interface", + "tags": [], "label": "ApplicationSetup", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 620 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ApplicationSetup.register", "type": "Function", + "tags": [], "label": "register", + "description": [ + "\nRegister an mountable application to the system." + ], "signature": [ "(app: ", { @@ -957,15 +1073,21 @@ }, ") => void" ], - "description": [ - "\nRegister an mountable application to the system." - ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 626 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ApplicationSetup.register.$1", "type": "Object", + "tags": [], "label": "app", - "isRequired": true, + "description": [ + "- an {@link App}" + ], "signature": [ { "pluginId": "core", @@ -976,26 +1098,25 @@ }, "" ], - "description": [ - "- an {@link App}" - ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 626 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 626 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ApplicationSetup.registerAppUpdater", "type": "Function", + "tags": [], "label": "registerAppUpdater", + "description": [ + "\nRegister an application updater that can be used to change the {@link AppUpdatableFields} fields\nof all applications at runtime.\n\nThis is meant to be used by plugins that needs to updates the whole list of applications.\nTo only updates a specific application, use the `updater$` property of the registered application instead.\n" + ], "signature": [ "(appUpdater$: ", "Observable", @@ -1009,15 +1130,19 @@ }, ">) => void" ], - "description": [ - "\nRegister an application updater that can be used to change the {@link AppUpdatableFields} fields\nof all applications at runtime.\n\nThis is meant to be used by plugins that needs to updates the whole list of applications.\nTo only updates a specific application, use the `updater$` property of the registered application instead.\n" - ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 655 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ApplicationSetup.registerAppUpdater.$1", "type": "Object", + "tags": [], "label": "appUpdater$", - "isRequired": true, + "description": [], "signature": [ "Observable", "<", @@ -1030,64 +1155,59 @@ }, ">" ], - "description": [], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 655 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 655 - } + "returnComment": [] } ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 620 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ApplicationStart", "type": "Interface", + "tags": [], "label": "ApplicationStart", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 696 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ApplicationStart.capabilities", "type": "Object", + "tags": [], "label": "capabilities", "description": [ "\nGets the read-only capabilities." ], + "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; }>; }>" + ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 695 + "lineNumber": 700 }, - "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; }>; }>" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ApplicationStart.applications$", "type": "Object", + "tags": [], "label": "applications$", "description": [ "\nObservable emitting the list of currently registered apps and their associated status.\n" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 704 - }, "signature": [ "Observable", ">" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 709 + }, + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.ApplicationStart.navigateToApp", "type": "Function", + "tags": [], "label": "navigateToApp", + "description": [ + "\nNavigate to a given app\n" + ], "signature": [ "(appId: string, options?: ", { @@ -1116,29 +1246,38 @@ }, " | undefined) => Promise" ], - "description": [ - "\nNavigate to a given app\n" - ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 717 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ApplicationStart.navigateToApp.$1", "type": "string", + "tags": [], "label": "appId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 712 - } + "lineNumber": 717 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ApplicationStart.navigateToApp.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [ + "- navigation options" + ], "signature": [ { "pluginId": "core", @@ -1149,194 +1288,205 @@ }, " | undefined" ], - "description": [ - "- navigation options" - ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 712 - } + "lineNumber": 717 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 712 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ApplicationStart.navigateToUrl", "type": "Function", + "tags": [], "label": "navigateToUrl", - "signature": [ - "(url: string) => Promise" - ], "description": [ "\nNavigate to given URL in a SPA friendly way when possible (when the URL will redirect to a valid application\nwithin the current basePath).\n\nThe method resolves pathnames the same way browsers do when resolving a `` value. The provided `url` can be:\n- an absolute URL\n- an absolute path\n- a path relative to the current URL (window.location.href)\n\nIf all these criteria are true for the given URL:\n- (only for absolute URLs) The origin of the URL matches the origin of the browser's current location\n- The resolved pathname of the provided URL/path starts with the current basePath (eg. /mybasepath/s/my-space)\n- The pathname segment after the basePath matches any known application route (eg. /app// or any application's `appRoute` configuration)\n\nThen a SPA navigation will be performed using `navigateToApp` using the corresponding application and path.\nOtherwise, fallback to a full page reload to navigate to the url using `window.location.assign`\n" ], + "signature": [ + "(url: string) => Promise" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 755 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ApplicationStart.navigateToUrl.$1", "type": "string", + "tags": [], "label": "url", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- an absolute URL, an absolute path or a relative path, to navigate to." ], + "signature": [ + "string" + ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 750 - } + "lineNumber": 755 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 750 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ApplicationStart.getUrlForApp", "type": "Function", + "tags": [], "label": "getUrlForApp", - "signature": [ - "(appId: string, options?: { path?: string | undefined; absolute?: boolean | undefined; } | undefined) => string" - ], "description": [ "\nReturns the absolute path (or URL) to a given app, including the global base path.\n\nBy default, it returns the absolute path of the application (e.g `/basePath/app/my-app`).\nUse the `absolute` option to generate an absolute url instead (e.g `http://host:port/basePath/app/my-app`)\n\nNote that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's current location.\n" ], + "signature": [ + "(appId: string, options?: { path?: string | undefined; absolute?: boolean | undefined; } | undefined) => string" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 769 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ApplicationStart.getUrlForApp.$1", "type": "string", + "tags": [], "label": "appId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 764 - } + "lineNumber": 769 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ApplicationStart.getUrlForApp.$2.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 769 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ApplicationStart.getUrlForApp.$2.options.path", "type": "string", + "tags": [], "label": "path", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 764 + "lineNumber": 769 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ApplicationStart.getUrlForApp.$2.options.absolute", "type": "CompoundType", + "tags": [], "label": "absolute", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 764 + "lineNumber": 769 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 764 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 764 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ApplicationStart.currentAppId$", "type": "Object", + "tags": [], "label": "currentAppId$", "description": [ "\nAn observable that emits the current application id and each subsequent id update." ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 769 - }, "signature": [ "Observable", "" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 774 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 691 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppMeta", "type": "Interface", + "tags": [], "label": "AppMeta", "description": [ "\nInput type for meta data for an application.\n\nMeta fields include `keywords` and `searchDeepLinks`\nKeywords is an array of string with which to associate the app, must include at least one unique string as an array.\n`searchDeepLinks` is an array of links that represent secondary in-app locations for the app." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 255 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppMeta.keywords", "type": "Array", + "tags": [], "label": "keywords", "description": [ "Keywords to represent this application" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 257 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppMeta.searchDeepLinks", "type": "Array", + "tags": [], "label": "searchDeepLinks", "description": [ "Array of links that represent secondary in-app locations for the app." ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 259 - }, "signature": [ { "pluginId": "core", @@ -1346,19 +1496,23 @@ "text": "AppSearchDeepLink" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 259 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 255 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppMountParameters", "type": "Interface", + "tags": [], "label": "AppMountParameters", + "description": [], "signature": [ { "pluginId": "core", @@ -1369,39 +1523,39 @@ }, "" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 349 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppMountParameters.element", "type": "Object", + "tags": [], "label": "element", "description": [ "\nThe container element to render the application into." ], + "signature": [ + "HTMLElement" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 353 }, - "signature": [ - "HTMLElement" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppMountParameters.history", "type": "Object", + "tags": [], "label": "history", "description": [ "\nA scoped history instance for your application. Should be used to wire up\nyour applications Router.\n" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 399 - }, "signature": [ { "pluginId": "core", @@ -1411,14 +1565,20 @@ "text": "ScopedHistory" }, "" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 399 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-public.AppMountParameters.appBasePath", + "type": "string", "tags": [ "deprecated" ], - "id": "def-public.AppMountParameters.appBasePath", - "type": "string", "label": "appBasePath", "description": [ "\nThe route path for configuring navigation to the application.\nThis string should not include the base path from HTTP.\n" @@ -1426,22 +1586,85 @@ "source": { "path": "src/core/public/application/types.ts", "lineNumber": 449 - } + }, + "deprecated": true, + "references": [ + { + "plugin": "management", + "link": { + "path": "src/plugins/management/public/application.tsx", + "lineNumber": 16 + } + }, + { + "plugin": "fleet", + "link": { + "path": "x-pack/plugins/fleet/public/applications/fleet/index.tsx", + "lineNumber": 67 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/account_management/account_management_app.test.ts", + "lineNumber": 57 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/authentication/access_agreement/access_agreement_app.test.ts", + "lineNumber": 50 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/authentication/logged_out/logged_out_app.test.ts", + "lineNumber": 48 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/authentication/login/login_app.test.ts", + "lineNumber": 53 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/authentication/logout/logout_app.test.ts", + "lineNumber": 54 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/authentication/overwritten_session/overwritten_session_app.test.ts", + "lineNumber": 55 + } + }, + { + "plugin": "fleet", + "link": { + "path": "x-pack/plugins/fleet/target/types/public/applications/fleet/index.d.ts", + "lineNumber": 11 + } + } + ] }, { + "parentPluginId": "core", + "id": "def-public.AppMountParameters.onAppLeave", + "type": "Function", "tags": [ "deprecated" ], - "id": "def-public.AppMountParameters.onAppLeave", - "type": "Function", "label": "onAppLeave", "description": [ "\nA function that can be used to register a handler that will be called\nwhen the user is leaving the current application, allowing to\nprompt a confirmation message before actually changing the page.\n\nThis will be called either when the user goes to another application, or when\ntrying to close the tab or manually changing the url.\n" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 484 - }, "signature": [ "(handler: ", { @@ -1452,20 +1675,157 @@ "text": "AppLeaveHandler" }, ") => void" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 484 + }, + "deprecated": true, + "references": [ + { + "plugin": "dashboard", + "link": { + "path": "src/plugins/dashboard/public/application/types.ts", + "lineNumber": 82 + } + }, + { + "plugin": "dashboard", + "link": { + "path": "src/plugins/dashboard/public/application/dashboard_router.tsx", + "lineNumber": 55 + } + }, + { + "plugin": "dashboard", + "link": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 305 + } + }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/public/app_plugin/types.ts", + "lineNumber": 75 + } + }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/public/app_plugin/mounter.tsx", + "lineNumber": 171 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/public/render_app.tsx", + "lineNumber": 68 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx", + "lineNumber": 60 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/public/routes/map_page/map_page.tsx", + "lineNumber": 19 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/public/application/app.tsx", + "lineNumber": 131 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/public/app/index.tsx", + "lineNumber": 17 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/account_management/account_management_app.test.ts", + "lineNumber": 58 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/target/types/public/render_app.d.ts", + "lineNumber": 5 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/authentication/access_agreement/access_agreement_app.test.ts", + "lineNumber": 51 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/authentication/logged_out/logged_out_app.test.ts", + "lineNumber": 49 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/authentication/login/login_app.test.ts", + "lineNumber": 54 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/authentication/logout/logout_app.test.ts", + "lineNumber": 55 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/public/authentication/overwritten_session/overwritten_session_app.test.ts", + "lineNumber": 56 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_page.d.ts", + "lineNumber": 9 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts", + "lineNumber": 14 + } + } ] }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.AppMountParameters.setHeaderActionMenu", "type": "Function", + "tags": [], "label": "setHeaderActionMenu", "description": [ "\nA function that can be used to set the mount point used to populate the application action container\nin the chrome header.\n\nCalling the handler multiple time will erase the current content of the action menu with the mount from the latest call.\nCalling the handler with `undefined` will unmount the current mount point.\nCalling the handler after the application has been unmounted will have no effect.\n" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 515 - }, "signature": [ "(menuMount: ", { @@ -1476,88 +1836,114 @@ "text": "MountPoint" }, " | undefined) => void" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 515 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 349 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.NavigateToAppOptions", "type": "Interface", + "tags": [], "label": "NavigateToAppOptions", "description": [ "\nOptions for the {@link ApplicationStart.navigateToApp | navigateToApp API}" ], - "tags": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 674 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.NavigateToAppOptions.path", "type": "string", + "tags": [], "label": "path", "description": [ "\noptional path inside application to deep link to.\nIf undefined, will use {@link App.defaultPath | the app's default path}` as default." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 679 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.NavigateToAppOptions.state", "type": "Unknown", + "tags": [], "label": "state", "description": [ "\noptional state to forward to the application" ], + "signature": [ + "unknown" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 683 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.NavigateToAppOptions.replace", "type": "CompoundType", + "tags": [], "label": "replace", "description": [ "\nif true, will not create a new history entry when navigating (using `replace` instead of `push`)" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 687 }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.NavigateToAppOptions.openInNewTab", + "type": "CompoundType", + "tags": [], + "label": "openInNewTab", + "description": [ + "\nif true, will open the app in new tab, will share session information via window.open if base" + ], "signature": [ "boolean | undefined" - ] + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 692 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 674 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "core", "id": "def-public.AppLeaveActionType", "type": "Enum", + "tags": [], "label": "AppLeaveActionType", - "tags": [ - "public" - ], "description": [ "\nPossible type of actions on application leave.\n" ], @@ -1565,15 +1951,15 @@ "path": "src/core/public/application/types.ts", "lineNumber": 540 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppNavLinkStatus", "type": "Enum", + "tags": [], "label": "AppNavLinkStatus", - "tags": [ - "public" - ], "description": [ "\nStatus of the application's navLink.\n" ], @@ -1581,15 +1967,15 @@ "path": "src/core/public/application/types.ts", "lineNumber": 40 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppStatus", "type": "Enum", + "tags": [], "label": "AppStatus", - "tags": [ - "public" - ], "description": [ "\nAccessibility status of an application.\n" ], @@ -1597,24 +1983,20 @@ "path": "src/core/public/application/types.ts", "lineNumber": 24 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "core", "id": "def-public.AppLeaveAction", "type": "Type", + "tags": [], "label": "AppLeaveAction", - "tags": [ - "public" - ], "description": [ "\nPossible actions to return from a {@link AppLeaveHandler}\n\nSee {@link AppLeaveConfirmAction} and {@link AppLeaveDefaultAction}\n" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 579 - }, "signature": [ { "pluginId": "core", @@ -1632,23 +2014,24 @@ "text": "AppLeaveConfirmAction" } ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 579 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppLeaveHandler", "type": "Type", - "label": "AppLeaveHandler", "tags": [ - "public", "deprecated" ], + "label": "AppLeaveHandler", "description": [ "\nA handler that will be executed before leaving the application, either when\ngoing to another application or when closing the browser tab or manually changing\nthe url.\nShould return `confirm` to prompt a message to the user before leaving the page, or `default`\nto keep the default behavior (doing nothing).\n\nSee {@link AppMountParameters} for detailed usage examples.\n" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 530 - }, "signature": [ "(factory: ", "AppLeaveActionFactory", @@ -1661,22 +2044,87 @@ "text": "AppLeaveAction" } ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 530 + }, + "deprecated": true, + "references": [ + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx", + "lineNumber": 14 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx", + "lineNumber": 30 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/public/app/home/index.tsx", + "lineNumber": 27 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/public/app/home/index.tsx", + "lineNumber": 44 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/public/app/routes.tsx", + "lineNumber": 13 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/public/app/routes.tsx", + "lineNumber": 23 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/public/app/app.tsx", + "lineNumber": 14 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/public/app/app.tsx", + "lineNumber": 33 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/public/app/app.tsx", + "lineNumber": 73 + } + } + ], "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppMount", "type": "Type", + "tags": [], "label": "AppMount", - "tags": [ - "public" - ], "description": [ "\nA mount function called when the user navigates to this app's route.\n" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 338 - }, "signature": [ "(params: ", { @@ -1704,22 +2152,22 @@ }, ">" ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 338 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppSearchDeepLink", "type": "Type", + "tags": [], "label": "AppSearchDeepLink", - "tags": [ - "public" - ], "description": [ "\nInput type for registering secondary in-app locations for an application.\n\nDeep links must include at least one of `path` or `searchDeepLinks`. A deep link that does not have a `path`\nrepresents a topological level in the application's hierarchy, but does not have a destination URL that is\nuser-accessible." ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 293 - }, "signature": [ "{ id: string; title: string; } & { path: string; searchDeepLinks?: ", { @@ -1739,60 +2187,60 @@ }, "[]; keywords?: string[] | undefined; }" ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 293 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppUnmount", "type": "Type", + "tags": [], "label": "AppUnmount", - "tags": [ - "public" - ], "description": [ "\nA function called when an application should be unmounted from the page. This function should be synchronous." ], + "signature": [ + "() => void" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 346 }, - "signature": [ - "() => void" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppUpdatableFields", "type": "Type", + "tags": [], "label": "AppUpdatableFields", - "tags": [ - "public" - ], "description": [ "\nDefines the list of fields that can be updated via an {@link AppUpdater}." ], + "signature": [ + "{ status?: AppStatus | undefined; meta?: AppMeta | undefined; navLinkStatus?: AppNavLinkStatus | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 64 }, - "signature": [ - "{ status?: AppStatus | undefined; meta?: AppMeta | undefined; navLinkStatus?: AppNavLinkStatus | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.AppUpdater", "type": "Type", + "tags": [], "label": "AppUpdater", - "tags": [ - "public" - ], "description": [ "\nUpdater for applications.\nsee {@link ApplicationSetup}" ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 74 - }, "signature": [ "(app: ", { @@ -1812,63 +2260,68 @@ }, ", \"status\" | \"meta\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\">> | undefined" ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 74 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.PublicAppInfo", "type": "Type", + "tags": [], "label": "PublicAppInfo", - "tags": [ - "public" - ], "description": [ "\nPublic information about a registered {@link App | application}\n" ], + "signature": [ + "Pick, \"status\" | \"title\" | \"id\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: AppStatus; navLinkStatus: AppNavLinkStatus; appRoute: string; meta: PublicAppMetaInfo; }" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 322 }, - "signature": [ - "Pick, \"status\" | \"title\" | \"id\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: AppStatus; navLinkStatus: AppNavLinkStatus; appRoute: string; meta: PublicAppMetaInfo; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.PublicAppMetaInfo", "type": "Type", + "tags": [], "label": "PublicAppMetaInfo", - "tags": [ - "public" - ], "description": [ "\nPublic information about a registered app's {@link AppMeta | keywords }\n" ], + "signature": [ + "Pick & { keywords: string[]; searchDeepLinks: PublicAppSearchDeepLinkInfo[]; }" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 267 }, - "signature": [ - "Pick & { keywords: string[]; searchDeepLinks: PublicAppSearchDeepLinkInfo[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.PublicAppSearchDeepLinkInfo", "type": "Type", + "tags": [], "label": "PublicAppSearchDeepLinkInfo", - "tags": [ - "public" - ], "description": [ "\nPublic information about a registered app's {@link AppSearchDeepLink | searchDeepLinks}\n" ], + "signature": [ + "Pick & { searchDeepLinks: PublicAppSearchDeepLinkInfo[]; keywords: string[]; }" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 277 }, - "signature": [ - "Pick & { searchDeepLinks: PublicAppSearchDeepLinkInfo[]; keywords: string[]; }" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/core_chrome.json b/api_docs/core_chrome.json index 8fa999791ee86..63bcd91b1b6b7 100644 --- a/api_docs/core_chrome.json +++ b/api_docs/core_chrome.json @@ -5,185 +5,207 @@ "functions": [], "interfaces": [ { + "parentPluginId": "core", "id": "def-public.ChromeBadge", "type": "Interface", + "tags": [], "label": "ChromeBadge", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeBadge.text", "type": "string", + "tags": [], "label": "text", "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeBadge.tooltip", "type": "string", + "tags": [], "label": "tooltip", "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeBadge.iconType", "type": "CompoundType", + "tags": [], "label": "iconType", "description": [], + "signature": [ + "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" + ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 22 }, - "signature": [ - "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeBrand", "type": "Interface", + "tags": [], "label": "ChromeBrand", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeBrand.logo", "type": "string", + "tags": [], "label": "logo", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 27 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeBrand.smallLogo", "type": "string", + "tags": [], "label": "smallLogo", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 28 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeDocTitle", "type": "Interface", + "tags": [], "label": "ChromeDocTitle", "description": [ "\nAPIs for accessing and updating the document title.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/doc_title/doc_title_service.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeDocTitle.change", "type": "Function", + "tags": [], "label": "change", - "signature": [ - "(newTitle: string | string[]) => void" - ], "description": [ "\nChanges the current document title.\n" ], + "signature": [ + "(newTitle: string | string[]) => void" + ], + "source": { + "path": "src/core/public/chrome/doc_title/doc_title_service.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeDocTitle.change.$1", "type": "CompoundType", + "tags": [], "label": "newTitle", - "isRequired": true, - "signature": [ - "string | string[]" - ], "description": [ "The new title to set, either a string or string array" ], + "signature": [ + "string | string[]" + ], "source": { "path": "src/core/public/chrome/doc_title/doc_title_service.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/doc_title/doc_title_service.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeDocTitle.reset", "type": "Function", + "tags": [], "label": "reset", - "signature": [ - "() => void" - ], "description": [ "\nResets the document title to it's initial value.\n(meaning the one present in the title meta at application load.)" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/core/public/chrome/doc_title/doc_title_service.ts", "lineNumber": 50 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/public/chrome/doc_title/doc_title_service.ts", - "lineNumber": 32 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeHelpExtension", "type": "Interface", + "tags": [], "label": "ChromeHelpExtension", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtension.appName", "type": "string", + "tags": [], "label": "appName", "description": [ "\nProvide your plugin's name to create a header for separation" @@ -191,20 +213,18 @@ "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 49 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtension.links", "type": "Array", + "tags": [], "label": "links", "description": [ "\nCreates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button" ], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 53 - }, "signature": [ { "pluginId": "core", @@ -214,35 +234,41 @@ "text": "ChromeHelpExtensionMenuLink" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 53 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtension.content", "type": "Function", + "tags": [], "label": "content", "description": [ "\nCustom content to occur below the list of links" ], + "signature": [ + "((element: HTMLDivElement) => () => void) | undefined" + ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 57 }, - "signature": [ - "((element: HTMLDivElement) => () => void) | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 45 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuCustomLink", "type": "Interface", + "tags": [], "label": "ChromeHelpExtensionMenuCustomLink", + "description": [], "signature": [ { "pluginId": "core", @@ -260,31 +286,35 @@ ", {}>, ", "PropsForButton" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 82 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuCustomLink.linkType", "type": "string", + "tags": [], "label": "linkType", "description": [ "\nExtend EuiButtonEmpty to provide extra functionality" ], + "signature": [ + "\"custom\"" + ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 86 }, - "signature": [ - "\"custom\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuCustomLink.href", "type": "string", + "tags": [], "label": "href", "description": [ "\nURL of the link" @@ -292,35 +322,37 @@ "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 90 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuCustomLink.content", "type": "CompoundType", + "tags": [], "label": "content", "description": [ "\nContent of the button (in lieu of `children`)" ], + "signature": [ + "React.ReactNode" + ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 94 }, - "signature": [ - "React.ReactNode" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", - "lineNumber": 82 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuDiscussLink", "type": "Interface", + "tags": [], "label": "ChromeHelpExtensionMenuDiscussLink", + "description": [], "signature": [ { "pluginId": "core", @@ -338,31 +370,35 @@ ", {}>, ", "PropsForButton" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuDiscussLink.linkType", "type": "string", + "tags": [], "label": "linkType", "description": [ "\nCreates a generic give feedback link with comment icon" ], + "signature": [ + "\"discuss\"" + ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 60 }, - "signature": [ - "\"discuss\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuDiscussLink.href", "type": "string", + "tags": [], "label": "href", "description": [ "\nURL to discuss page.\ni.e. `https://discuss.elastic.co/c/${appName}`" @@ -370,19 +406,19 @@ "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 65 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", - "lineNumber": 56 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuDocumentationLink", "type": "Interface", + "tags": [], "label": "ChromeHelpExtensionMenuDocumentationLink", + "description": [], "signature": [ { "pluginId": "core", @@ -400,31 +436,35 @@ ", {}>, ", "PropsForButton" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuDocumentationLink.linkType", "type": "string", + "tags": [], "label": "linkType", "description": [ "\nCreates a deep-link to app-specific documentation" ], + "signature": [ + "\"documentation\"" + ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 73 }, - "signature": [ - "\"documentation\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuDocumentationLink.href", "type": "string", + "tags": [], "label": "href", "description": [ "\nURL to documentation page.\ni.e. `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html`," @@ -432,19 +472,19 @@ "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 78 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", - "lineNumber": 69 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuGitHubLink", "type": "Interface", + "tags": [], "label": "ChromeHelpExtensionMenuGitHubLink", + "description": [], "signature": [ { "pluginId": "core", @@ -462,99 +502,105 @@ ", {}>, ", "PropsForButton" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuGitHubLink.linkType", "type": "string", + "tags": [], "label": "linkType", "description": [ "\nCreates a link to a new github issue in the Kibana repo" ], + "signature": [ + "\"github\"" + ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 44 }, - "signature": [ - "\"github\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuGitHubLink.labels", "type": "Array", + "tags": [], "label": "labels", "description": [ "\nInclude at least one app-specific label to be applied to the new github issue" ], + "signature": [ + "string[]" + ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 48 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuGitHubLink.title", "type": "string", + "tags": [], "label": "title", "description": [ "\nProvides initial text for the title of the issue" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 52 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", - "lineNumber": 40 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeNavControl", "type": "Interface", + "tags": [], "label": "ChromeNavControl", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavControl.order", "type": "number", + "tags": [], "label": "order", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 16 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavControl.mount", "type": "Function", + "tags": [], "label": "mount", "description": [], - "source": { - "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", - "lineNumber": 17 - }, "signature": [ { "pluginId": "core", @@ -564,30 +610,40 @@ "text": "MountPoint" }, "" - ] + ], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 17 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeNavControls", "type": "Interface", + "tags": [], "label": "ChromeNavControls", "description": [ "\n{@link ChromeNavControls | APIs} for registering new controls to be displayed in the navigation bar.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeNavControls.registerLeft", "type": "Function", + "tags": [], "label": "registerLeft", + "description": [ + "Register a nav control to be presented on the bottom-left side of the chrome header." + ], "signature": [ "(navControl: ", { @@ -599,15 +655,19 @@ }, ") => void" ], - "description": [ - "Register a nav control to be presented on the bottom-left side of the chrome header." - ], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeNavControls.registerLeft.$1", "type": "Object", + "tags": [], "label": "navControl", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -617,24 +677,25 @@ "text": "ChromeNavControl" } ], - "description": [], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", - "lineNumber": 38 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeNavControls.registerRight", "type": "Function", + "tags": [], "label": "registerRight", + "description": [ + "Register a nav control to be presented on the top-right side of the chrome header." + ], "signature": [ "(navControl: ", { @@ -646,15 +707,19 @@ }, ") => void" ], - "description": [ - "Register a nav control to be presented on the top-right side of the chrome header." - ], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeNavControls.registerRight.$1", "type": "Object", + "tags": [], "label": "navControl", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -664,24 +729,25 @@ "text": "ChromeNavControl" } ], - "description": [], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 40 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", - "lineNumber": 40 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeNavControls.registerCenter", "type": "Function", + "tags": [], "label": "registerCenter", + "description": [ + "Register a nav control to be presented on the top-center side of the chrome header." + ], "signature": [ "(navControl: ", { @@ -693,15 +759,19 @@ }, ") => void" ], - "description": [ - "Register a nav control to be presented on the top-center side of the chrome header." - ], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeNavControls.registerCenter.$1", "type": "Object", + "tags": [], "label": "navControl", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -711,40 +781,37 @@ "text": "ChromeNavControl" } ], - "description": [], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", - "lineNumber": 42 - } + "returnComment": [] } ], - "source": { - "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", - "lineNumber": 36 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeNavLink", "type": "Interface", + "tags": [], "label": "ChromeNavLink", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nA unique identifier for looking up links." @@ -752,12 +819,14 @@ "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.title", "type": "string", + "tags": [], "label": "title", "description": [ "\nThe title of the application." @@ -765,29 +834,33 @@ "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.category", "type": "Object", + "tags": [], "label": "category", "description": [ "\nThe category the app lives in" ], + "signature": [ + "AppCategory", + " | undefined" + ], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 29 }, - "signature": [ - "AppCategory", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.baseUrl", "type": "string", + "tags": [], "label": "baseUrl", "description": [ "\nThe base route used to open the root of an application." @@ -795,92 +868,104 @@ "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 34 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.url", "type": "string", + "tags": [], "label": "url", "description": [ "\nThe route used to open the {@link AppBase.defaultPath | default path } of an application.\nIf unset, `baseUrl` will be used instead." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 40 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.order", "type": "number", + "tags": [], "label": "order", "description": [ "\nAn ordinal used to sort nav links relative to one another for display." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 45 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.tooltip", "type": "string", + "tags": [], "label": "tooltip", "description": [ "\nA tooltip shown when hovering over an app link." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 50 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.euiIconType", "type": "string", + "tags": [], "label": "euiIconType", "description": [ "\nA EUI iconType that will be used for the app's icon. This icon\ntakes precedence over the `icon` property." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 56 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.icon", "type": "string", + "tags": [], "label": "icon", "description": [ "\nA URL to an image file used as an icon. Used as a fallback\nif `euiIconType` is not provided." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 62 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.href", "type": "string", + "tags": [], "label": "href", "description": [ "\nSettled state between `url`, `baseUrl`, and `active`" @@ -888,62 +973,72 @@ "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 67 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.disabled", "type": "CompoundType", + "tags": [], "label": "disabled", "description": [ "\nDisables a link from being clickable.\n" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 76 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeNavLink.hidden", "type": "CompoundType", + "tags": [], "label": "hidden", "description": [ "\nHides a link from the navigation." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 81 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/nav_links/nav_link.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks", "type": "Interface", + "tags": [], "label": "ChromeNavLinks", "description": [ "\n{@link ChromeNavLinks | APIs} for manipulating nav links.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.getNavLinks$", "type": "Function", + "tags": [], "label": "getNavLinks$", + "description": [ + "\nGet an observable for a sorted list of navlinks." + ], "signature": [ "() => ", "Observable", @@ -957,21 +1052,23 @@ }, ">[]>" ], - "description": [ - "\nGet an observable for a sorted list of navlinks." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.get", "type": "Function", + "tags": [], "label": "get", + "description": [ + "\nGet the state of a navlink at this point in time." + ], "signature": [ "(id: string) => ", { @@ -983,36 +1080,41 @@ }, " | undefined" ], - "description": [ - "\nGet the state of a navlink at this point in time." - ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/nav_links/nav_links_service.ts", - "lineNumber": 38 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.getAll", "type": "Function", + "tags": [], "label": "getAll", + "description": [ + "\nGet the current state of all navlinks." + ], "signature": [ "() => Readonly<", { @@ -1024,87 +1126,101 @@ }, ">[]" ], - "description": [ - "\nGet the current state of all navlinks." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 43 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.has", "type": "Function", + "tags": [], "label": "has", - "signature": [ - "(id: string) => boolean" - ], "description": [ "\nCheck whether or not a navlink exists." ], + "signature": [ + "(id: string) => boolean" + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.has.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/nav_links/nav_links_service.ts", - "lineNumber": 49 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.showOnly", "type": "Function", + "tags": [], "label": "showOnly", - "signature": [ - "(id: string) => void" - ], "description": [ "\nRemove all navlinks except the one matching the given id.\n" ], + "signature": [ + "(id: string) => void" + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.showOnly.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/nav_links/nav_links_service.ts", - "lineNumber": 59 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.update", "type": "Function", + "tags": [ + "deprecated" + ], "label": "update", + "description": [ + "\nUpdate the navlink for the given id with the updated attributes.\nReturns the updated navlink or `undefined` if it does not exist.\n" + ], "signature": [ "(id: string, values: Partial>" ], - "description": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 71 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "deprecated" - ], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/nav_links/nav_links_service.ts", - "lineNumber": 71 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.enableForcedAppSwitcherNavigation", "type": "Function", + "tags": [], "label": "enableForcedAppSwitcherNavigation", - "signature": [ - "() => void" - ], "description": [ "\nEnable forced navigation mode, which will trigger a page refresh\nwhen a nav link is clicked and only the hash is updated.\n" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 85 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeNavLinks.getForceAppSwitcherNavigation$", "type": "Function", + "tags": [], "label": "getForceAppSwitcherNavigation$", + "description": [ + "\nAn observable of the forced app switcher state." + ], "signature": [ "() => ", "Observable", "" ], - "description": [ - "\nAn observable of the forced app switcher state." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 90 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/public/chrome/nav_links/nav_links_service.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessed", "type": "Interface", + "tags": [], "label": "ChromeRecentlyAccessed", "description": [ "\n{@link ChromeRecentlyAccessed | APIs} for recently accessed history." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 58 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessed.add", "type": "Function", + "tags": [], "label": "add", - "signature": [ - "(link: string, label: string, id: string) => void" - ], "description": [ "\nAdds a new item to the recently accessed history.\n" ], + "signature": [ + "(link: string, label: string, id: string) => void" + ], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessed.add.$1", "type": "string", + "tags": [], "label": "link", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "a relative URL to the resource (not including the {@link HttpStart.basePath | `http.basePath`})" ], + "signature": [ + "string" + ], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 71 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessed.add.$2", "type": "string", + "tags": [], "label": "label", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "the label to display in the UI" ], + "signature": [ + "string" + ], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 71 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessed.add.$3", "type": "string", + "tags": [], "label": "id", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "a unique string used to de-duplicate the recently accessed list." ], + "signature": [ + "string" + ], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 71 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", - "lineNumber": 71 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessed.get", "type": "Function", + "tags": [], "label": "get", + "description": [ + "\nGets an Array of the current recently accessed history.\n" + ], "signature": [ "() => ", { @@ -1312,21 +1465,23 @@ }, "[]" ], - "description": [ - "\nGets an Array of the current recently accessed history.\n" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessed.get$", "type": "Function", + "tags": [], "label": "get$", + "description": [ + "\nGets an Observable of the array of recently accessed history.\n" + ], "signature": [ "() => ", "Observable", @@ -1340,96 +1495,96 @@ }, "[]>" ], - "description": [ - "\nGets an Observable of the array of recently accessed history.\n" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 91 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", - "lineNumber": 58 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessedHistoryItem", "type": "Interface", + "tags": [], "label": "ChromeRecentlyAccessedHistoryItem", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessedHistoryItem.link", "type": "string", + "tags": [], "label": "link", "description": [], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessedHistoryItem.label", "type": "string", + "tags": [], "label": "label", "description": [], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeRecentlyAccessedHistoryItem.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 19 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeStart", "type": "Interface", + "tags": [], "label": "ChromeStart", "description": [ "\nChromeStart allows plugins to customize the global chrome header UI and\nenrich the UX with additional information about the current location of the\nbrowser.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeStart.navLinks", "type": "Object", + "tags": [], "label": "navLinks", "description": [ "{@inheritdoc ChromeNavLinks}" ], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 88 - }, "signature": [ { "pluginId": "core", @@ -1438,20 +1593,22 @@ "section": "def-public.ChromeNavLinks", "text": "ChromeNavLinks" } - ] + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 88 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeStart.navControls", "type": "Object", + "tags": [], "label": "navControls", "description": [ "{@inheritdoc ChromeNavControls}" ], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 90 - }, "signature": [ { "pluginId": "core", @@ -1460,20 +1617,22 @@ "section": "def-public.ChromeNavControls", "text": "ChromeNavControls" } - ] + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 90 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeStart.recentlyAccessed", "type": "Object", + "tags": [], "label": "recentlyAccessed", "description": [ "{@inheritdoc ChromeRecentlyAccessed}" ], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 92 - }, "signature": [ { "pluginId": "core", @@ -1482,20 +1641,22 @@ "section": "def-public.ChromeRecentlyAccessed", "text": "ChromeRecentlyAccessed" } - ] + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 92 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeStart.docTitle", "type": "Object", + "tags": [], "label": "docTitle", "description": [ "{@inheritdoc ChromeDocTitle}" ], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 94 - }, "signature": [ { "pluginId": "core", @@ -1504,45 +1665,60 @@ "section": "def-public.ChromeDocTitle", "text": "ChromeDocTitle" } - ] + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 94 + }, + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.setAppTitle", "type": "Function", + "tags": [], "label": "setAppTitle", - "signature": [ - "(appTitle: string) => void" - ], "description": [ "\nSets the current app's title\n" ], + "signature": [ + "(appTitle: string) => void" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 103 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.setAppTitle.$1", "type": "string", + "tags": [], "label": "appTitle", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 103 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 103 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.getBrand$", "type": "Function", + "tags": [], "label": "getBrand$", + "description": [ + "\nGet an observable of the current brand information." + ], "signature": [ "() => ", "Observable", @@ -1556,21 +1732,23 @@ }, ">" ], - "description": [ - "\nGet an observable of the current brand information." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 108 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.setBrand", "type": "Function", + "tags": [], "label": "setBrand", + "description": [ + "\nSet the brand configuration.\n" + ], "signature": [ "(brand: ", { @@ -1582,15 +1760,19 @@ }, ") => void" ], - "description": [ - "\nSet the brand configuration.\n" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 128 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.setBrand.$1", "type": "Object", + "tags": [], "label": "brand", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1600,163 +1782,183 @@ "text": "ChromeBrand" } ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 128 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 128 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.getIsVisible$", "type": "Function", + "tags": [], "label": "getIsVisible$", + "description": [ + "\nGet an observable of the current visibility state of the chrome." + ], "signature": [ "() => ", "Observable", "" ], - "description": [ - "\nGet an observable of the current visibility state of the chrome." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 133 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.setIsVisible", "type": "Function", + "tags": [], "label": "setIsVisible", - "signature": [ - "(isVisible: boolean) => void" - ], "description": [ "\nSet the temporary visibility for the chrome. This does nothing if the chrome is hidden\nby default and should be used to hide the chrome for things like full-screen modes\nwith an exit button." ], + "signature": [ + "(isVisible: boolean) => void" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 140 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.setIsVisible.$1", "type": "boolean", + "tags": [], "label": "isVisible", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 140 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 140 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.getApplicationClasses$", "type": "Function", + "tags": [], "label": "getApplicationClasses$", + "description": [ + "\nGet the current set of classNames that will be set on the application container." + ], "signature": [ "() => ", "Observable", "" ], - "description": [ - "\nGet the current set of classNames that will be set on the application container." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 145 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.addApplicationClass", "type": "Function", + "tags": [], "label": "addApplicationClass", - "signature": [ - "(className: string) => void" - ], "description": [ "\nAdd a className that should be set on the application container." ], + "signature": [ + "(className: string) => void" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 150 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.addApplicationClass.$1", "type": "string", + "tags": [], "label": "className", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 150 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 150 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.removeApplicationClass", "type": "Function", + "tags": [], "label": "removeApplicationClass", - "signature": [ - "(className: string) => void" - ], "description": [ "\nRemove a className added with `addApplicationClass()`. If className is unknown it is ignored." ], + "signature": [ + "(className: string) => void" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 155 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.removeApplicationClass.$1", "type": "string", + "tags": [], "label": "className", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 155 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 155 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.getBadge$", "type": "Function", + "tags": [], "label": "getBadge$", + "description": [ + "\nGet an observable of the current badge" + ], "signature": [ "() => ", "Observable", @@ -1770,21 +1972,23 @@ }, " | undefined>" ], - "description": [ - "\nGet an observable of the current badge" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 160 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.setBadge", "type": "Function", + "tags": [], "label": "setBadge", + "description": [ + "\nOverride the current badge" + ], "signature": [ "(badge?: ", { @@ -1796,15 +2000,19 @@ }, " | undefined) => void" ], - "description": [ - "\nOverride the current badge" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 165 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.setBadge.$1", "type": "Object", + "tags": [], "label": "badge", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -1815,24 +2023,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 165 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 165 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.getBreadcrumbs$", "type": "Function", + "tags": [], "label": "getBreadcrumbs$", + "description": [ + "\nGet an observable of the current list of breadcrumbs" + ], "signature": [ "() => ", "Observable", @@ -1840,57 +2049,64 @@ "EuiBreadcrumb", "[]>" ], - "description": [ - "\nGet an observable of the current list of breadcrumbs" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 170 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.setBreadcrumbs", "type": "Function", + "tags": [], "label": "setBreadcrumbs", + "description": [ + "\nOverride the current set of breadcrumbs" + ], "signature": [ "(newBreadcrumbs: ", "EuiBreadcrumb", "[]) => void" ], - "description": [ - "\nOverride the current set of breadcrumbs" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 175 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.setBreadcrumbs.$1", "type": "Array", + "tags": [], "label": "newBreadcrumbs", - "isRequired": true, + "description": [], "signature": [ "EuiBreadcrumb", "[]" ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 175 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 175 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.getBreadcrumbsAppendExtension$", "type": "Function", + "tags": [], "label": "getBreadcrumbsAppendExtension$", + "description": [ + "\nGet an observable of the current extension appended to breadcrumbs" + ], "signature": [ "() => ", "Observable", @@ -1898,57 +2114,64 @@ "ChromeBreadcrumbsAppendExtension", " | undefined>" ], - "description": [ - "\nGet an observable of the current extension appended to breadcrumbs" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 180 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.setBreadcrumbsAppendExtension", "type": "Function", + "tags": [], "label": "setBreadcrumbsAppendExtension", + "description": [ + "\nMount an element next to the last breadcrumb" + ], "signature": [ "(breadcrumbsAppendExtension?: ", "ChromeBreadcrumbsAppendExtension", " | undefined) => void" ], - "description": [ - "\nMount an element next to the last breadcrumb" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 185 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.setBreadcrumbsAppendExtension.$1", "type": "Object", + "tags": [], "label": "breadcrumbsAppendExtension", - "isRequired": false, + "description": [], "signature": [ "ChromeBreadcrumbsAppendExtension", " | undefined" ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 186 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 185 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.getCustomNavLink$", "type": "Function", + "tags": [], "label": "getCustomNavLink$", + "description": [ + "\nGet an observable of the current custom nav link" + ], "signature": [ "() => ", "Observable", @@ -1962,21 +2185,23 @@ }, "> | undefined>" ], - "description": [ - "\nGet an observable of the current custom nav link" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 192 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.setCustomNavLink", "type": "Function", + "tags": [], "label": "setCustomNavLink", + "description": [ + "\nOverride the current set of custom nav link" + ], "signature": [ "(newCustomNavLink?: Partial<", { @@ -1988,15 +2213,19 @@ }, "> | undefined) => void" ], - "description": [ - "\nOverride the current set of custom nav link" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 197 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.setCustomNavLink.$1", "type": "Object", + "tags": [], "label": "newCustomNavLink", - "isRequired": false, + "description": [], "signature": [ "Partial<", { @@ -2008,24 +2237,25 @@ }, "> | undefined" ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 197 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 197 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.getHelpExtension$", "type": "Function", + "tags": [], "label": "getHelpExtension$", + "description": [ + "\nGet an observable of the current custom help conttent" + ], "signature": [ "() => ", "Observable", @@ -2039,21 +2269,23 @@ }, " | undefined>" ], - "description": [ - "\nGet an observable of the current custom help conttent" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 202 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.setHelpExtension", "type": "Function", + "tags": [], "label": "setHelpExtension", + "description": [ + "\nOverride the current set of custom help content" + ], "signature": [ "(helpExtension?: ", { @@ -2065,15 +2297,19 @@ }, " | undefined) => void" ], - "description": [ - "\nOverride the current set of custom help content" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 207 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.setHelpExtension.$1", "type": "Object", + "tags": [], "label": "helpExtension", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2084,79 +2320,87 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 207 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 207 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.setHelpSupportUrl", "type": "Function", + "tags": [], "label": "setHelpSupportUrl", - "signature": [ - "(url: string) => void" - ], "description": [ "\nOverride the default support URL shown in the help menu" ], + "signature": [ + "(url: string) => void" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 213 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.setHelpSupportUrl.$1", "type": "string", + "tags": [], "label": "url", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "The updated support URL" ], + "signature": [ + "string" + ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 213 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 213 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.getIsNavDrawerLocked$", "type": "Function", + "tags": [], "label": "getIsNavDrawerLocked$", + "description": [ + "\nGet an observable of the current locked state of the nav drawer." + ], "signature": [ "() => ", "Observable", "" ], - "description": [ - "\nGet an observable of the current locked state of the nav drawer." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 218 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.ChromeStart.setHeaderBanner", "type": "Function", + "tags": [], "label": "setHeaderBanner", + "description": [ + "\nSet the banner that will appear on top of the chrome header.\n" + ], "signature": [ "(headerBanner?: ", { @@ -2168,15 +2412,19 @@ }, " | undefined) => void" ], - "description": [ - "\nSet the banner that will appear on top of the chrome header.\n" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 225 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.ChromeStart.setHeaderBanner.$1", "type": "Object", + "tags": [], "label": "headerBanner", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2187,46 +2435,39 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 225 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 225 - } + "returnComment": [] } ], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 86 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeUserBanner", "type": "Interface", + "tags": [], "label": "ChromeUserBanner", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.ChromeUserBanner.content", "type": "Function", + "tags": [], "label": "content", "description": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 41 - }, "signature": [ { "pluginId": "core", @@ -2236,30 +2477,26 @@ "text": "MountPoint" }, "" - ] + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 41 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 40 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "core", "id": "def-public.ChromeBreadcrumb", "type": "Type", + "tags": [], "label": "ChromeBreadcrumb", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/core/public/chrome/types.ts", - "lineNumber": 32 - }, "signature": [ "CommonProps", " & { text: ", @@ -2268,37 +2505,37 @@ "MouseEvent", ") => void) | undefined; truncate?: boolean | undefined; }" ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 32 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionLinkBase", "type": "Type", + "tags": [], "label": "ChromeHelpExtensionLinkBase", - "tags": [ - "public" - ], "description": [], + "signature": [ + "{ iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; 'data-test-subj'?: string | undefined; target?: string | undefined; rel?: string | undefined; }" + ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 34 }, - "signature": [ - "{ iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; 'data-test-subj'?: string | undefined; target?: string | undefined; rel?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeHelpExtensionMenuLink", "type": "Type", + "tags": [], "label": "ChromeHelpExtensionMenuLink", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", - "lineNumber": 98 - }, "signature": [ { "pluginId": "core", @@ -2332,38 +2569,45 @@ "text": "ChromeHelpExtensionMenuCustomLink" } ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 98 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.ChromeNavLinkUpdateableFields", "type": "Type", + "tags": [], "label": "ChromeNavLinkUpdateableFields", - "tags": [ - "public" - ], "description": [], + "signature": [ + "{ readonly hidden?: boolean | undefined; readonly disabled?: boolean | undefined; readonly href?: string | undefined; readonly url?: string | undefined; }" + ], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 85 }, - "signature": [ - "{ readonly hidden?: boolean | undefined; readonly disabled?: boolean | undefined; readonly href?: string | undefined; readonly url?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.NavType", "type": "Type", - "label": "NavType", "tags": [], + "label": "NavType", "description": [], + "signature": [ + "\"modern\" | \"legacy\"" + ], "source": { "path": "src/core/public/chrome/ui/header/types.ts", "lineNumber": 10 }, - "signature": [ - "\"legacy\" | \"modern\"" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/core_http.json b/api_docs/core_http.json index c65171153a6fb..17656f765f5b1 100644 --- a/api_docs/core_http.json +++ b/api_docs/core_http.json @@ -5,9 +5,14 @@ "functions": [], "interfaces": [ { + "parentPluginId": "core", "id": "def-public.HttpFetchOptions", "type": "Interface", + "tags": [], "label": "HttpFetchOptions", + "description": [ + "\nAll options that may be used with a {@link HttpHandler}." + ], "signature": [ { "pluginId": "core", @@ -25,25 +30,21 @@ "text": "HttpRequestInit" } ], - "description": [ - "\nAll options that may be used with a {@link HttpHandler}." - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 245 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpFetchOptions.query", "type": "Object", + "tags": [], "label": "query", "description": [ "\nThe query string for an HTTP request. See {@link HttpFetchQuery}." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 249 - }, "signature": [ { "pluginId": "core", @@ -53,36 +54,40 @@ "text": "HttpFetchQuery" }, " | undefined" - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 249 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpFetchOptions.prependBasePath", "type": "CompoundType", + "tags": [], "label": "prependBasePath", "description": [ "\nWhether or not the request should automatically prepend the basePath. Defaults to `true`." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 254 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpFetchOptions.headers", "type": "Object", + "tags": [], "label": "headers", "description": [ "\nHeaders to send with the request. See {@link HttpHeadersInit}." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 259 - }, "signature": [ { "pluginId": "core", @@ -92,51 +97,61 @@ "text": "HttpHeadersInit" }, " | undefined" - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 259 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpFetchOptions.asSystemRequest", "type": "CompoundType", + "tags": [], "label": "asSystemRequest", "description": [ "\nWhether or not the request should include the \"system request\" header to differentiate an end user request from\nKibana internal request.\nCan be read on the server-side using KibanaRequest#isSystemRequest. Defaults to `false`." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 266 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpFetchOptions.asResponse", "type": "CompoundType", + "tags": [], "label": "asResponse", "description": [ "\nWhen `true` the return type of {@link HttpHandler} will be an {@link HttpResponse} with detailed request and\nresponse information. When `false`, the return type will just be the parsed response body. Defaults to `false`." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 272 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 245 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.HttpFetchOptionsWithPath", "type": "Interface", + "tags": [], "label": "HttpFetchOptionsWithPath", + "description": [ + "\nSimilar to {@link HttpFetchOptions} but with the URL path included." + ], "signature": [ { "pluginId": "core", @@ -154,184 +169,202 @@ "text": "HttpFetchOptions" } ], - "description": [ - "\nSimilar to {@link HttpFetchOptions} but with the URL path included." - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 279 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpFetchOptionsWithPath.path", "type": "string", + "tags": [], "label": "path", "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 283 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 279 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.HttpFetchQuery", "type": "Interface", + "tags": [], "label": "HttpFetchQuery", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 225 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.HttpFetchQuery.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [ "\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n | string\n | number\n | boolean\n | Array\n | undefined\n | null;" ], + "signature": [ + "any" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 238 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 225 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.HttpHandler", "type": "Interface", + "tags": [], "label": "HttpHandler", "description": [ "\nA function for making an HTTP requests to Kibana's backend. See {@link HttpFetchOptions} for options and\n{@link HttpResponse} for the response.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 295 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.HttpHandler.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 296 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.HttpHandler.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 299 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.HttpHandler.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 302 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.HttpHandler.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 303 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 295 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.HttpHeadersInit", "type": "Interface", + "tags": [], "label": "HttpHeadersInit", "description": [ "\nHeaders to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause\n{@link HttpHandler} to throw an error." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 144 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.HttpHeadersInit.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 145 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 144 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.HttpInterceptor", "type": "Interface", + "tags": [], "label": "HttpInterceptor", "description": [ "\nAn object that may define global interceptor functions for different parts of the request and response lifecycle.\nSee {@link IHttpInterceptController}.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 362 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.request", "type": "Function", + "tags": [], "label": "request", + "description": [ + "\nDefine an interceptor to be executed before a request is sent." + ], "signature": [ "((fetchOptions: Readonly<", { @@ -367,15 +400,19 @@ }, ">>) | undefined" ], - "description": [ - "\nDefine an interceptor to be executed before a request is sent." - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 368 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.request.$1", "type": "Object", + "tags": [], "label": "fetchOptions", - "isRequired": true, + "description": [], "signature": [ "Readonly<", { @@ -387,17 +424,20 @@ }, ">" ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 369 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.request.$2", "type": "Object", + "tags": [], "label": "controller", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -407,24 +447,25 @@ "text": "IHttpInterceptController" } ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 370 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 368 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.requestError", "type": "Function", + "tags": [], "label": "requestError", + "description": [ + "\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise." + ], "signature": [ "((httpErrorRequest: ", { @@ -460,15 +501,19 @@ }, ">>) | undefined" ], - "description": [ - "\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise." - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 378 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.requestError.$1", "type": "Object", + "tags": [], "label": "httpErrorRequest", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -478,17 +523,20 @@ "text": "HttpInterceptorRequestError" } ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 379 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.requestError.$2", "type": "Object", + "tags": [], "label": "controller", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -498,24 +546,25 @@ "text": "IHttpInterceptController" } ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 380 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 378 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.response", "type": "Function", + "tags": [], "label": "response", + "description": [ + "\nDefine an interceptor to be executed after a response is received." + ], "signature": [ "((httpResponse: ", { @@ -551,15 +600,19 @@ }, ">) | undefined" ], - "description": [ - "\nDefine an interceptor to be executed after a response is received." - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 388 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.response.$1", "type": "Object", + "tags": [], "label": "httpResponse", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -570,17 +623,20 @@ }, "" ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 389 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.response.$2", "type": "Object", + "tags": [], "label": "controller", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -590,24 +646,25 @@ "text": "IHttpInterceptController" } ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 390 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 388 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.responseError", "type": "Function", + "tags": [], "label": "responseError", + "description": [ + "\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise." + ], "signature": [ "((httpErrorResponse: ", { @@ -643,15 +700,19 @@ }, ">) | undefined" ], - "description": [ - "\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise." - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 398 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.responseError.$1", "type": "Object", + "tags": [], "label": "httpErrorResponse", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -661,17 +722,20 @@ "text": "HttpInterceptorResponseError" } ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 399 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.HttpInterceptor.responseError.$2", "type": "Object", + "tags": [], "label": "controller", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -681,46 +745,39 @@ "text": "IHttpInterceptController" } ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 400 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 398 - } + "returnComment": [] } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 362 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.HttpInterceptorRequestError", "type": "Interface", + "tags": [], "label": "HttpInterceptorRequestError", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 351 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpInterceptorRequestError.fetchOptions", "type": "Object", + "tags": [], "label": "fetchOptions", "description": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 352 - }, "signature": [ "Readonly<", { @@ -731,33 +788,39 @@ "text": "HttpFetchOptionsWithPath" }, ">" - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 352 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpInterceptorRequestError.error", "type": "Object", + "tags": [], "label": "error", "description": [], + "signature": [ + "Error" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 353 }, - "signature": [ - "Error" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 351 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.HttpInterceptorResponseError", "type": "Interface", + "tags": [], "label": "HttpInterceptorResponseError", + "description": [], "signature": [ { "pluginId": "core", @@ -776,35 +839,35 @@ }, "" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 346 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpInterceptorResponseError.request", "type": "Object", + "tags": [], "label": "request", "description": [], + "signature": [ + "Readonly" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 347 }, - "signature": [ - "Readonly" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpInterceptorResponseError.error", "type": "CompoundType", + "tags": [], "label": "error", "description": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 348 - }, "signature": [ "Error | ", { @@ -814,86 +877,94 @@ "section": "def-public.IHttpFetchError", "text": "IHttpFetchError" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 348 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 346 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.HttpRequestInit", "type": "Interface", + "tags": [], "label": "HttpRequestInit", "description": [ "\nFetch API options available to {@link HttpHandler}s.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 154 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.body", "type": "CompoundType", + "tags": [], "label": "body", "description": [ "\nA BodyInit object or null to set request's body." ], + "signature": [ + "string | ArrayBuffer | Blob | URLSearchParams | ArrayBufferView | FormData | ReadableStream | null | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 158 }, - "signature": [ - "string | ArrayBuffer | Blob | URLSearchParams | ArrayBufferView | FormData | ReadableStream | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.cache", "type": "CompoundType", + "tags": [], "label": "cache", "description": [ "\nThe cache mode associated with request, which is a string indicating how the request will interact with the\nbrowser's cache when fetching." ], + "signature": [ + "\"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 164 }, - "signature": [ - "\"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.credentials", "type": "CompoundType", + "tags": [], "label": "credentials", "description": [ "\nThe credentials mode associated with request, which is a string indicating whether credentials will be sent with\nthe request always, never, or only when sent to a same-origin URL." ], + "signature": [ + "\"include\" | \"omit\" | \"same-origin\" | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 170 }, - "signature": [ - "\"include\" | \"omit\" | \"same-origin\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.headers", "type": "Object", + "tags": [], "label": "headers", "description": [ "{@link HttpHeadersInit}" ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 173 - }, "signature": [ { "pluginId": "core", @@ -903,163 +974,185 @@ "text": "HttpHeadersInit" }, " | undefined" - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 173 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.integrity", "type": "string", + "tags": [], "label": "integrity", "description": [ "\nSubresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of\nmultiple hashes separated by whitespace." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 179 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.keepalive", "type": "CompoundType", + "tags": [], "label": "keepalive", "description": [ "Whether or not request can outlive the global in which it was created." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 182 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.method", "type": "string", + "tags": [], "label": "method", "description": [ "HTTP method, which is \"GET\" by default." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 185 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.mode", "type": "CompoundType", + "tags": [], "label": "mode", "description": [ "\nThe mode associated with request, which is a string indicating whether the request will use CORS, or will be\nrestricted to same-origin URLs." ], + "signature": [ + "\"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 191 }, - "signature": [ - "\"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.redirect", "type": "CompoundType", + "tags": [], "label": "redirect", "description": [ "\nThe redirect mode associated with request, which is a string indicating how redirects for the request will be\nhandled during fetching. A request will follow redirects by default." ], + "signature": [ + "\"error\" | \"follow\" | \"manual\" | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 197 }, - "signature": [ - "\"error\" | \"follow\" | \"manual\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.referrer", "type": "string", + "tags": [], "label": "referrer", "description": [ "\nThe referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to\nindicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to\ndetermine the value of the `Referer` header of the request being made." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 204 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.referrerPolicy", "type": "CompoundType", + "tags": [], "label": "referrerPolicy", "description": [ "\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer." ], + "signature": [ + "\"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 210 }, - "signature": [ - "\"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.signal", "type": "CompoundType", + "tags": [], "label": "signal", "description": [ "\nReturns the signal associated with request, which is an AbortSignal object indicating whether or not request has\nbeen aborted, and its abort event handler." ], + "signature": [ + "AbortSignal | null | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 216 }, - "signature": [ - "AbortSignal | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpRequestInit.window", "type": "Uncategorized", + "tags": [], "label": "window", "description": [ "\nCan only be null. Used to disassociate request from any Window." ], + "signature": [ + "null | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 221 }, - "signature": [ - "null | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 154 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.HttpResponse", "type": "Interface", + "tags": [], "label": "HttpResponse", + "description": [], "signature": [ { "pluginId": "core", @@ -1070,23 +1163,21 @@ }, "" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 307 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpResponse.fetchOptions", "type": "Object", + "tags": [], "label": "fetchOptions", "description": [ "The original {@link HttpFetchOptionsWithPath} used to send this request." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 309 - }, "signature": [ "Readonly<", { @@ -1097,84 +1188,92 @@ "text": "HttpFetchOptionsWithPath" }, ">" - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 309 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpResponse.request", "type": "Object", + "tags": [], "label": "request", "description": [ "Raw request sent to Kibana server." ], + "signature": [ + "Readonly" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 311 }, - "signature": [ - "Readonly" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpResponse.response", "type": "Object", + "tags": [], "label": "response", "description": [ "Raw response received, may be undefined if there was an error." ], + "signature": [ + "Readonly | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 313 }, - "signature": [ - "Readonly | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpResponse.body", "type": "Uncategorized", + "tags": [], "label": "body", "description": [ "Parsed body received, may be undefined if there was an error." ], + "signature": [ + "TResponseBody | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 315 }, - "signature": [ - "TResponseBody | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 307 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.HttpSetup", "type": "Interface", + "tags": [], "label": "HttpSetup", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.basePath", "type": "Object", + "tags": [], "label": "basePath", "description": [ "\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}" ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "core", @@ -1183,20 +1282,22 @@ "section": "def-public.IBasePath", "text": "IBasePath" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.anonymousPaths", "type": "Object", + "tags": [], "label": "anonymousPaths", "description": [ "\nAPIs for denoting certain paths for not requiring authentication" ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 23 - }, "signature": [ { "pluginId": "core", @@ -1205,18 +1306,20 @@ "section": "def-public.IAnonymousPaths", "text": "IAnonymousPaths" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 23 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.externalUrl", "type": "Object", + "tags": [], "label": "externalUrl", "description": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 25 - }, "signature": [ { "pluginId": "core", @@ -1225,12 +1328,22 @@ "section": "def-public.IExternalUrl", "text": "IExternalUrl" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 25 + }, + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.HttpSetup.intercept", "type": "Function", + "tags": [], "label": "intercept", + "description": [ + "\nAdds a new {@link HttpInterceptor} to the global HTTP client." + ], "signature": [ "(interceptor: ", { @@ -1242,15 +1355,21 @@ }, ") => () => void" ], - "description": [ - "\nAdds a new {@link HttpInterceptor} to the global HTTP client." - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.HttpSetup.intercept.$1", "type": "Object", + "tags": [], "label": "interceptor", - "isRequired": true, + "description": [ + "a {@link HttpInterceptor}" + ], "signature": [ { "pluginId": "core", @@ -1260,36 +1379,27 @@ "text": "HttpInterceptor" } ], - "description": [ - "a {@link HttpInterceptor}" - ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "a function for removing the attached interceptor." - ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 32 - } + ] }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.fetch", "type": "Function", + "tags": [], "label": "fetch", "description": [ "Makes an HTTP request. Defaults to a GET request unless overriden. See {@link HttpHandler} for options." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 35 - }, "signature": [ { "pluginId": "core", @@ -1298,20 +1408,22 @@ "section": "def-public.HttpHandler", "text": "HttpHandler" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 35 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.delete", "type": "Function", + "tags": [], "label": "delete", "description": [ "Makes an HTTP request with the DELETE method. See {@link HttpHandler} for options." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 37 - }, "signature": [ { "pluginId": "core", @@ -1320,20 +1432,22 @@ "section": "def-public.HttpHandler", "text": "HttpHandler" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.get", "type": "Function", + "tags": [], "label": "get", "description": [ "Makes an HTTP request with the GET method. See {@link HttpHandler} for options." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 39 - }, "signature": [ { "pluginId": "core", @@ -1342,20 +1456,22 @@ "section": "def-public.HttpHandler", "text": "HttpHandler" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 39 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.head", "type": "Function", + "tags": [], "label": "head", "description": [ "Makes an HTTP request with the HEAD method. See {@link HttpHandler} for options." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 41 - }, "signature": [ { "pluginId": "core", @@ -1364,20 +1480,22 @@ "section": "def-public.HttpHandler", "text": "HttpHandler" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 41 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.options", "type": "Function", + "tags": [], "label": "options", "description": [ "Makes an HTTP request with the OPTIONS method. See {@link HttpHandler} for options." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 43 - }, "signature": [ { "pluginId": "core", @@ -1386,20 +1504,22 @@ "section": "def-public.HttpHandler", "text": "HttpHandler" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 43 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.patch", "type": "Function", + "tags": [], "label": "patch", "description": [ "Makes an HTTP request with the PATCH method. See {@link HttpHandler} for options." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 45 - }, "signature": [ { "pluginId": "core", @@ -1408,20 +1528,22 @@ "section": "def-public.HttpHandler", "text": "HttpHandler" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 45 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.post", "type": "Function", + "tags": [], "label": "post", "description": [ "Makes an HTTP request with the POST method. See {@link HttpHandler} for options." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 47 - }, "signature": [ { "pluginId": "core", @@ -1430,20 +1552,22 @@ "section": "def-public.HttpHandler", "text": "HttpHandler" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 47 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.HttpSetup.put", "type": "Function", + "tags": [], "label": "put", "description": [ "Makes an HTTP request with the PUT method. See {@link HttpHandler} for options." ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 49 - }, "signature": [ { "pluginId": "core", @@ -1452,218 +1576,249 @@ "section": "def-public.HttpHandler", "text": "HttpHandler" } - ] + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 49 + }, + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.HttpSetup.addLoadingCountSource", "type": "Function", + "tags": [], "label": "addLoadingCountSource", + "description": [ + "\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0." + ], "signature": [ "(countSource$: ", "Observable", ") => void" ], - "description": [ - "\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0." - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.HttpSetup.addLoadingCountSource.$1", "type": "Object", + "tags": [], "label": "countSource$", - "isRequired": true, + "description": [ + "an Observable to subscribe to for loading count updates." + ], "signature": [ "Observable", "" ], - "description": [ - "an Observable to subscribe to for loading count updates." - ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 56 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 56 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.HttpSetup.getLoadingCount$", "type": "Function", + "tags": [], "label": "getLoadingCount$", + "description": [ + "\nGet the sum of all loading count sources as a single Observable." + ], "signature": [ "() => ", "Observable", "" ], - "description": [ - "\nGet the sum of all loading count sources as a single Observable." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.IAnonymousPaths", "type": "Interface", + "tags": [], "label": "IAnonymousPaths", "description": [ "\nAPIs for denoting paths as not requiring authentication" ], - "tags": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 127 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.IAnonymousPaths.isAnonymous", "type": "Function", + "tags": [], "label": "isAnonymous", - "signature": [ - "(path: string) => boolean" - ], "description": [ "\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath." ], + "signature": [ + "(path: string) => boolean" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 131 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.IAnonymousPaths.isAnonymous.$1", "type": "string", + "tags": [], "label": "path", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 131 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 131 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.IAnonymousPaths.register", "type": "Function", + "tags": [], "label": "register", - "signature": [ - "(path: string) => void" - ], "description": [ "\nRegister `path` as not requiring authentication. `path` should not include the current basePath." ], + "signature": [ + "(path: string) => void" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 136 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.IAnonymousPaths.register.$1", "type": "string", + "tags": [], "label": "path", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 136 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 136 - } + "returnComment": [] } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 127 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.IBasePath", "type": "Interface", + "tags": [], "label": "IBasePath", "description": [ "\nAPIs for manipulating the basePath on URL segments." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.IBasePath.get", "type": "Function", + "tags": [], "label": "get", "description": [ "\nGets the `basePath` string." ], + "signature": [ + "() => string" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 78 }, - "signature": [ - "() => string" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IBasePath.prepend", "type": "Function", + "tags": [], "label": "prepend", "description": [ "\nPrepends `path` with the basePath." ], + "signature": [ + "(url: string) => string" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 83 }, - "signature": [ - "(url: string) => string" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IBasePath.remove", "type": "Function", + "tags": [], "label": "remove", "description": [ "\nRemoves the prepended basePath from the `path`." ], + "signature": [ + "(url: string) => string" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 88 }, - "signature": [ - "(url: string) => string" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IBasePath.serverBasePath", "type": "string", + "tags": [], "label": "serverBasePath", "description": [ "\nReturns the server's root basePath as configured, without any namespace prefix.\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" @@ -1671,86 +1826,93 @@ "source": { "path": "src/core/public/http/types.ts", "lineNumber": 95 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IBasePath.publicBaseUrl", "type": "string", + "tags": [], "label": "publicBaseUrl", "description": [ "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 104 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 74 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.IExternalUrl", "type": "Interface", + "tags": [], "label": "IExternalUrl", "description": [ "\nAPIs for working with external URLs.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 111 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.IExternalUrl.validateUrl", "type": "Function", + "tags": [], "label": "validateUrl", - "signature": [ - "(relativeOrAbsoluteUrl: string) => URL | null" - ], "description": [ "\nDetermines if the provided URL is a valid location to send users.\nValidation is based on the configured allow list in kibana.yml.\n\nIf the URL is valid, then a URL will be returned.\nOtherwise, this will return null.\n" ], + "signature": [ + "(relativeOrAbsoluteUrl: string) => URL | null" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 121 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.IExternalUrl.validateUrl.$1", "type": "string", + "tags": [], "label": "relativeOrAbsoluteUrl", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 121 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 121 - } + "returnComment": [] } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 111 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.IHttpFetchError", "type": "Interface", + "tags": [], "label": "IHttpFetchError", + "description": [], "signature": [ { "pluginId": "core", @@ -1761,118 +1923,149 @@ }, " extends Error" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 330 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.IHttpFetchError.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 331 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IHttpFetchError.request", "type": "Object", + "tags": [], "label": "request", "description": [], + "signature": [ + "Request" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 332 }, - "signature": [ - "Request" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IHttpFetchError.response", "type": "Object", + "tags": [], "label": "response", "description": [], + "signature": [ + "Response | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 333 }, - "signature": [ - "Response | undefined" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-public.IHttpFetchError.req", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-public.IHttpFetchError.req", - "type": "Object", "label": "req", "description": [], + "signature": [ + "Request" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 337 }, - "signature": [ - "Request" + "deprecated": true, + "references": [ + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts", + "lineNumber": 44 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts", + "lineNumber": 58 + } + } ] }, { + "parentPluginId": "core", + "id": "def-public.IHttpFetchError.res", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-public.IHttpFetchError.res", - "type": "Object", "label": "res", "description": [], + "signature": [ + "Response | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 341 }, - "signature": [ - "Response | undefined" - ] + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IHttpFetchError.body", "type": "Any", + "tags": [], "label": "body", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 342 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 330 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.IHttpInterceptController", "type": "Interface", + "tags": [], "label": "IHttpInterceptController", "description": [ "\nUsed to halt a request Promise chain in a {@link HttpInterceptor}." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 408 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.IHttpInterceptController.halted", "type": "boolean", + "tags": [], "label": "halted", "description": [ "Whether or not this chain has been halted." @@ -1880,37 +2073,41 @@ "source": { "path": "src/core/public/http/types.ts", "lineNumber": 410 - } + }, + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.IHttpInterceptController.halt", "type": "Function", + "tags": [], "label": "halt", - "signature": [ - "() => void" - ], "description": [ "Halt the request Promise chain and do not process further interceptors or response handlers." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 412 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 408 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.IHttpResponseInterceptorOverrides", "type": "Interface", + "tags": [], "label": "IHttpResponseInterceptorOverrides", + "description": [ + "\nProperties that can be returned by HttpInterceptor.request to override the response." + ], "signature": [ { "pluginId": "core", @@ -1919,74 +2116,73 @@ "section": "def-public.IHttpResponseInterceptorOverrides", "text": "IHttpResponseInterceptorOverrides" }, - "" - ], - "description": [ - "\nProperties that can be returned by HttpInterceptor.request to override the response." - ], - "tags": [ - "public" + "" ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 322 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.IHttpResponseInterceptorOverrides.response", "type": "Object", + "tags": [], "label": "response", "description": [ "Raw response received, may be undefined if there was an error." ], + "signature": [ + "Readonly | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 324 }, - "signature": [ - "Readonly | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.IHttpResponseInterceptorOverrides.body", "type": "Uncategorized", + "tags": [], "label": "body", "description": [ "Parsed body received, may be undefined if there was an error." ], + "signature": [ + "TResponseBody | undefined" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 326 }, - "signature": [ - "TResponseBody | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 322 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "core", "id": "def-public.HttpStart", "type": "Type", + "tags": [], "label": "HttpStart", - "tags": [ - "public" - ], "description": [ "\nSee {@link HttpSetup}" ], + "signature": [ + "HttpSetup" + ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 68 }, - "signature": [ - "HttpSetup" - ], + "deprecated": false, "initialIsOpen": false } ], @@ -1995,20 +2191,25 @@ "server": { "classes": [ { + "parentPluginId": "core", "id": "def-server.BasePath", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "BasePath", "description": [ "\nAccess or manipulate the Kibana base path\n" ], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.BasePath.serverBasePath", "type": "string", + "tags": [], "label": "serverBasePath", "description": [ "\nreturns the server's basePath\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" @@ -2016,33 +2217,68 @@ "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 26 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.BasePath.publicBaseUrl", "type": "string", + "tags": [], "label": "publicBaseUrl", "description": [ "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link BasePath.serverBasePath}.\n" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 34 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.BasePath.get", "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nreturns `basePath` value, specific for an incoming request." + ], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ") => string" + ], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.BasePath.get.$1", "type": "CompoundType", + "tags": [], "label": "request", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2060,13 +2296,27 @@ "text": "LegacyRequest" } ], - "description": [], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.BasePath.set", + "type": "Function", + "tags": [ + "privateRemarks" + ], + "label": "set", + "description": [ + "\nsets `basePath` value, specific for an incoming request.\n" + ], "signature": [ "(request: ", { @@ -2084,28 +2334,21 @@ "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, - ") => string" - ], - "description": [ - "\nreturns `basePath` value, specific for an incoming request." + ", requestSpecificBasePath: string) => void" ], - "label": "get", "source": { "path": "src/core/server/http/base_path_service.ts", - "lineNumber": 45 + "lineNumber": 55 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.BasePath.set", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.BasePath.set.$1", "type": "CompoundType", + "tags": [], "label": "request", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2123,138 +2366,117 @@ "text": "LegacyRequest" } ], - "description": [], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.BasePath.set.$2", "type": "string", + "tags": [], "label": "requestSpecificBasePath", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.LegacyRequest", - "text": "LegacyRequest" - }, - ", requestSpecificBasePath: string) => void" - ], - "description": [ - "\nsets `basePath` value, specific for an incoming request.\n" - ], - "label": "set", - "source": { - "path": "src/core/server/http/base_path_service.ts", - "lineNumber": 55 - }, - "tags": [ - "privateRemarks" - ], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.BasePath.prepend", "type": "Function", + "tags": [], + "label": "prepend", + "description": [ + "\nPrepends `path` with the basePath." + ], + "signature": [ + "(path: string) => string" + ], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.BasePath.prepend.$1", "type": "string", + "tags": [], "label": "path", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 69 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.BasePath.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nRemoves the prepended basePath from the `path`." + ], "signature": [ "(path: string) => string" ], - "description": [ - "\nPrepends `path` with the basePath." - ], - "label": "prepend", "source": { "path": "src/core/server/http/base_path_service.ts", - "lineNumber": 69 + "lineNumber": 81 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.BasePath.remove", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.BasePath.remove.$1", "type": "string", + "tags": [], "label": "path", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(path: string) => string" - ], - "description": [ - "\nRemoves the prepended basePath from the `path`." - ], - "label": "remove", - "source": { - "path": "src/core/server/http/base_path_service.ts", - "lineNumber": 81 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/core/server/http/base_path_service.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.KibanaRequest", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "KibanaRequest", "description": [ "\nKibana specific abstraction for an incoming request." @@ -2269,11 +2491,17 @@ }, "" ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 90 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequest.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nA identifier to identify this request.\n" @@ -2281,12 +2509,14 @@ "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 144 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequest.uuid", "type": "string", + "tags": [], "label": "uuid", "description": [ "\nA UUID to identify this request.\n" @@ -2294,36 +2524,36 @@ "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 152 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequest.url", "type": "Object", + "tags": [], "label": "url", "description": [ "a WHATWG URL standard object." ], + "signature": [ + "URL" + ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 154 }, - "signature": [ - "URL" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequest.route", "type": "Object", + "tags": [], "label": "route", "description": [ "matched route details" ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 156 - }, "signature": [ "Readonly<{ path: string; method: ", "RecursiveReadonly", @@ -2338,20 +2568,22 @@ "text": "KibanaRequestRouteOptions" }, ">; }>" - ] + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 156 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequest.headers", "type": "CompoundType", + "tags": [], "label": "headers", "description": [ "\nReadonly copy of incoming request headers." ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 162 - }, "signature": [ { "pluginId": "core", @@ -2360,12 +2592,18 @@ "section": "def-server.Headers", "text": "Headers" } - ] + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 162 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequest.isSystemRequest", "type": "boolean", + "tags": [], "label": "isSystemRequest", "description": [ "\nWhether or not the request is a \"system request\" rather than an application-level request.\nCan be set on the client using the `HttpFetchOptions#asSystemRequest` option." @@ -2373,20 +2611,18 @@ "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 167 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequest.socket", "type": "Object", + "tags": [], "label": "socket", "description": [ "{@link IKibanaSocket}" ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 170 - }, "signature": [ { "pluginId": "core", @@ -2395,20 +2631,22 @@ "section": "def-server.IKibanaSocket", "text": "IKibanaSocket" } - ] + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 170 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequest.events", "type": "Object", + "tags": [], "label": "events", "description": [ "Request events {@link KibanaRequestEvents}" ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 172 - }, "signature": [ { "pluginId": "core", @@ -2417,139 +2655,160 @@ "section": "def-server.KibanaRequestEvents", "text": "KibanaRequestEvents" } - ] + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 172 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequest.auth", "type": "Object", + "tags": [], "label": "auth", "description": [], + "signature": [ + "{ isAuthenticated: boolean; }" + ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 173 }, - "signature": [ - "{ isAuthenticated: boolean; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequest.rewrittenUrl", "type": "Object", + "tags": [], "label": "rewrittenUrl", "description": [ "\nURL rewritten in onPreRouting request interceptor." ], + "signature": [ + "URL", + " | undefined" + ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 181 }, - "signature": [ - "URL", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 186 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed.$1", "type": "Object", + "tags": [], "label": "request", - "isRequired": true, + "description": [], "signature": [ "Request" ], - "description": [], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 187 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed.$2", "type": "Uncategorized", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "Params" ], - "description": [], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 188 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed.$3", "type": "Uncategorized", + "tags": [], "label": "query", - "isRequired": true, + "description": [], "signature": [ "Query" ], - "description": [], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 189 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed.$4", "type": "Uncategorized", + "tags": [], "label": "body", - "isRequired": true, + "description": [], "signature": [ "Body" ], - "description": [], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 190 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed.$5", "type": "boolean", + "tags": [], "label": "withoutSecretHeaders", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 193 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 186 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 90 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteValidationError", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "RouteValidationError", "description": [ "\nError to return when the validation is not successful." @@ -2565,66 +2824,78 @@ " extends ", "SchemaTypeError" ], + "source": { + "path": "src/core/server/http/router/validator/validator_error.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.RouteValidationError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/server/http/router/validator/validator_error.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.RouteValidationError.Unnamed.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "string | Error" ], - "description": [], "source": { "path": "src/core/server/http/router/validator/validator_error.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.RouteValidationError.Unnamed.$2", "type": "Array", + "tags": [], "label": "path", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "src/core/server/http/router/validator/validator_error.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/http/router/validator/validator_error.ts", - "lineNumber": 16 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/http/router/validator/validator_error.ts", - "lineNumber": 15 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "core", "id": "def-server.Authenticated", "type": "Interface", + "tags": [], "label": "Authenticated", + "description": [], "signature": [ { "pluginId": "core", @@ -2642,21 +2913,19 @@ "text": "AuthResultParams" } ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.Authenticated.type", "type": "string", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 30 - }, "signature": [ { "pluginId": "core", @@ -2666,34 +2935,36 @@ "text": "AuthResultType" }, ".authenticated" - ] + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 30 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.AuthNotHandled", "type": "Interface", + "tags": [], "label": "AuthNotHandled", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.AuthNotHandled.type", "type": "string", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 35 - }, "signature": [ { "pluginId": "core", @@ -2703,19 +2974,23 @@ "text": "AuthResultType" }, ".notHandled" - ] + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 35 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.AuthRedirected", "type": "Interface", + "tags": [], "label": "AuthRedirected", + "description": [], "signature": [ { "pluginId": "core", @@ -2733,21 +3008,19 @@ "text": "AuthRedirectedParams" } ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.AuthRedirected.type", "type": "string", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 40 - }, "signature": [ { "pluginId": "core", @@ -2757,136 +3030,146 @@ "text": "AuthResultType" }, ".redirected" - ] + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 40 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 39 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.AuthRedirectedParams", "type": "Interface", + "tags": [], "label": "AuthRedirectedParams", "description": [ "\nResult of auth redirection." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 109 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.AuthRedirectedParams.headers", "type": "CompoundType", + "tags": [], "label": "headers", "description": [ "\nHeaders to attach for auth redirect.\nMust include \"location\" header" ], + "signature": [ + "({ location: string; } & Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record)" + ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 114 }, - "signature": [ - "({ location: string; } & Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record)" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 109 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.AuthResultParams", "type": "Interface", + "tags": [], "label": "AuthResultParams", "description": [ "\nResult of successful authentication." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 88 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.AuthResultParams.state", "type": "Object", + "tags": [], "label": "state", "description": [ "\nData to associate with an incoming request. Any downstream plugin may get access to the data." ], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 92 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.AuthResultParams.requestHeaders", "type": "Object", + "tags": [], "label": "requestHeaders", "description": [ "\nAuth specific headers to attach to a request object.\nUsed to perform a request to Elasticsearch on behalf of an authenticated user." ], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 97 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.AuthResultParams.responseHeaders", "type": "Object", + "tags": [], "label": "responseHeaders", "description": [ "\nAuth specific headers to attach to a response object.\nUsed to send back authentication mechanism related headers to a client when needed." ], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 102 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 88 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.AuthToolkit", "type": "Interface", + "tags": [], "label": "AuthToolkit", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 121 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.AuthToolkit.authenticated", "type": "Function", + "tags": [], "label": "authenticated", "description": [ "Authentication is successful with given credentials, allow request to pass through" ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 123 - }, "signature": [ "(data?: ", { @@ -2904,20 +3187,22 @@ "section": "def-server.AuthResult", "text": "AuthResult" } - ] + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 123 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.AuthToolkit.notHandled", "type": "Function", + "tags": [], "label": "notHandled", "description": [ "\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true" ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 129 - }, "signature": [ "() => ", { @@ -2927,20 +3212,22 @@ "section": "def-server.AuthResult", "text": "AuthResult" } - ] + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 129 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.AuthToolkit.redirected", "type": "Function", + "tags": [], "label": "redirected", "description": [ "\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'" ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 134 - }, "signature": [ "(headers: ({ location: string; } & Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record)) => ", { @@ -2950,19 +3237,25 @@ "section": "def-server.AuthResult", "text": "AuthResult" } - ] + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 134 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 121 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.CustomHttpResponseOptions", "type": "Interface", + "tags": [], "label": "CustomHttpResponseOptions", + "description": [ + "\nHTTP response parameters for a response with adjustable status code." + ], "signature": [ { "pluginId": "core", @@ -2973,134 +3266,158 @@ }, "" ], - "description": [ - "\nHTTP response parameters for a response with adjustable status code." - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 79 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.CustomHttpResponseOptions.body", "type": "Uncategorized", + "tags": [], "label": "body", "description": [ "HTTP message to send to the client" ], + "signature": [ + "T | undefined" + ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 79 + "lineNumber": 81 }, - "signature": [ - "T | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.CustomHttpResponseOptions.headers", "type": "CompoundType", + "tags": [], "label": "headers", "description": [ "HTTP Headers with additional information about response" ], + "signature": [ + "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" + ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 81 + "lineNumber": 83 }, - "signature": [ - "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.CustomHttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", "tags": [], + "label": "bypassErrorFormat", + "description": [ + "Bypass the default error formatting" + ], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 85 + }, + "deprecated": false + }, + { + "parentPluginId": "core", "id": "def-server.CustomHttpResponseOptions.statusCode", "type": "number", + "tags": [], "label": "statusCode", "description": [], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 82 - } + "lineNumber": 86 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 77 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ErrorHttpResponseOptions", "type": "Interface", + "tags": [], "label": "ErrorHttpResponseOptions", "description": [ "\nHTTP response parameters" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 103 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.ErrorHttpResponseOptions.body", "type": "CompoundType", + "tags": [], "label": "body", "description": [ "HTTP message to send to the client" ], + "signature": [ + "string | Error | { message: string | Error; attributes?: Record | undefined; } | undefined" + ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 101 + "lineNumber": 105 }, - "signature": [ - "string | Error | { message: string | Error; attributes?: Record | undefined; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ErrorHttpResponseOptions.headers", "type": "CompoundType", + "tags": [], "label": "headers", "description": [ "HTTP Headers with additional information about response" ], + "signature": [ + "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" + ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 103 + "lineNumber": 107 }, - "signature": [ - "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 99 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HttpAuth", "type": "Interface", + "tags": [], "label": "HttpAuth", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpAuth.get", "type": "Function", + "tags": [], "label": "get", "description": [ "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 51 - }, "signature": [ { "pluginId": "core", @@ -3109,20 +3426,22 @@ "section": "def-server.GetAuthState", "text": "GetAuthState" } - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpAuth.isAuthenticated", "type": "Function", + "tags": [], "label": "isAuthenticated", "description": [ "\nReturns authentication status for a request.\n{@link IsAuthenticated}" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 56 - }, "signature": [ { "pluginId": "core", @@ -3131,38 +3450,40 @@ "section": "def-server.IsAuthenticated", "text": "IsAuthenticated" } - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 56 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 46 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HttpResponseOptions", "type": "Interface", + "tags": [], "label": "HttpResponseOptions", "description": [ "\nHTTP response parameters" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpResponseOptions.body", "type": "CompoundType", + "tags": [], "label": "body", "description": [ "HTTP message to send to the client" ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 62 - }, "signature": [ { "pluginId": "core", @@ -3171,127 +3492,157 @@ "section": "def-server.HttpResponsePayload", "text": "HttpResponsePayload" } - ] + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 62 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpResponseOptions.headers", "type": "CompoundType", + "tags": [], "label": "headers", "description": [ "HTTP Headers with additional information about response" ], + "signature": [ + "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" + ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 64 }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", + "tags": [], + "label": "bypassErrorFormat", + "description": [ + "Bypass the default error formatting" + ], "signature": [ - "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" - ] + "boolean | undefined" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 66 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 60 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HttpServerInfo", "type": "Interface", + "tags": [], "label": "HttpServerInfo", "description": [ "\nInformation about what hostname, port, and protocol the server process is\nrunning on. Note that this may not match the URL that end-users access\nKibana at. For the public URL, see {@link BasePath.publicBaseUrl}." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 341 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServerInfo.name", "type": "string", + "tags": [], "label": "name", "description": [ "The name of the Kibana server" ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 336 - } + "lineNumber": 343 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServerInfo.hostname", "type": "string", + "tags": [], "label": "hostname", "description": [ "The hostname of the server" ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 338 - } + "lineNumber": 345 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServerInfo.port", "type": "number", + "tags": [], "label": "port", "description": [ "The port the server is listening on" ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 340 - } + "lineNumber": 347 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServerInfo.protocol", "type": "CompoundType", + "tags": [], "label": "protocol", "description": [ "The protocol used by the server" ], + "signature": [ + "\"http\" | \"https\" | \"socket\"" + ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 342 + "lineNumber": 349 }, - "signature": [ - "\"http\" | \"https\" | \"socket\"" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 334 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HttpServiceSetup", "type": "Interface", + "tags": [], "label": "HttpServiceSetup", "description": [ "\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 131 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory", "type": "Function", + "tags": [], "label": "createCookieSessionStorageFactory", "description": [ "\nCreates cookie based session storage factory {@link SessionStorageFactory}" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 136 - }, "signature": [ "(cookieOptions: ", { @@ -3310,20 +3661,22 @@ "text": "SessionStorageFactory" }, ">" - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 136 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerOnPreRouting", "type": "Function", + "tags": [], "label": "registerOnPreRouting", "description": [ "\nTo define custom logic to perform for incoming requests before server performs a route lookup.\n" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 150 - }, "signature": [ "(handler: ", { @@ -3334,20 +3687,22 @@ "text": "OnPreRoutingHandler" }, ") => void" - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 150 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerOnPreAuth", "type": "Function", + "tags": [], "label": "registerOnPreAuth", "description": [ "\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 162 - }, "signature": [ "(handler: ", { @@ -3358,20 +3713,22 @@ "text": "OnPreAuthHandler" }, ") => void" - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 162 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerAuth", "type": "Function", + "tags": [], "label": "registerAuth", "description": [ "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 174 - }, "signature": [ "(handler: ", { @@ -3382,20 +3739,22 @@ "text": "AuthenticationHandler" }, ") => void" - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 174 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerOnPostAuth", "type": "Function", + "tags": [], "label": "registerOnPostAuth", "description": [ "\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 186 - }, "signature": [ "(handler: ", { @@ -3406,20 +3765,22 @@ "text": "OnPostAuthHandler" }, ") => void" - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 186 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerOnPreResponse", "type": "Function", + "tags": [], "label": "registerOnPreResponse", "description": [ "\nTo define custom logic to perform for the server response.\n" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 198 - }, "signature": [ "(handler: ", { @@ -3430,20 +3791,22 @@ "text": "OnPreResponseHandler" }, ") => void" - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 198 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceSetup.basePath", "type": "Object", + "tags": [], "label": "basePath", "description": [ "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 204 - }, "signature": [ "Pick<", { @@ -3454,22 +3817,24 @@ "text": "BasePath" }, ", \"remove\" | \"get\" | \"prepend\" | \"set\" | \"serverBasePath\" | \"publicBaseUrl\">" - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 204 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.auth", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-server.HttpServiceSetup.auth", - "type": "Object", "label": "auth", "description": [ "\nAuth status.\nSee {@link HttpAuth}\n" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 212 - }, "signature": [ { "pluginId": "core", @@ -3478,20 +3843,23 @@ "section": "def-server.HttpAuth", "text": "HttpAuth" } - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 212 + }, + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceSetup.csp", "type": "Object", + "tags": [], "label": "csp", "description": [ "\nThe CSP config used for Kibana." ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 217 - }, "signature": [ { "pluginId": "core", @@ -3500,22 +3868,22 @@ "section": "def-server.ICspConfig", "text": "ICspConfig" } - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 217 + }, + "deprecated": false }, { - "tags": [ - "public" - ], + "parentPluginId": "core", "id": "def-server.HttpServiceSetup.createRouter", "type": "Function", + "tags": [], "label": "createRouter", "description": [ "\nProvides ability to declare a handler function for a particular path and HTTP request method.\n" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 234 - }, "signature": [ "" - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 234 + }, + "deprecated": false }, { - "tags": [ - "public" - ], + "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", "type": "Function", + "tags": [], "label": "registerRouteHandlerContext", "description": [ "\nRegister a context provider for a route handler." ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 266 - }, "signature": [ " ", { @@ -3606,36 +3976,38 @@ "section": "def-server.HttpServerInfo", "text": "HttpServerInfo" } - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 277 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 131 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HttpServiceStart", "type": "Interface", + "tags": [], "label": "HttpServiceStart", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 310 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceStart.basePath", "type": "Object", + "tags": [], "label": "basePath", "description": [ "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 308 - }, "signature": [ "Pick<", { @@ -3646,20 +4018,22 @@ "text": "BasePath" }, ", \"remove\" | \"get\" | \"prepend\" | \"set\" | \"serverBasePath\" | \"publicBaseUrl\">" - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 315 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceStart.auth", "type": "Object", + "tags": [], "label": "auth", "description": [ "\nAuth status.\nSee {@link HttpAuth}" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 314 - }, "signature": [ { "pluginId": "core", @@ -3668,20 +4042,22 @@ "section": "def-server.HttpAuth", "text": "HttpAuth" } - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 321 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServiceStart.getServerInfo", "type": "Function", + "tags": [], "label": "getServerInfo", "description": [ "\nProvides common {@link HttpServerInfo | information} about the running http server." ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 319 - }, "signature": [ "() => ", { @@ -3691,19 +4067,25 @@ "section": "def-server.HttpServerInfo", "text": "HttpServerInfo" } - ] + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 326 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 303 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.IKibanaResponse", "type": "Interface", + "tags": [], "label": "IKibanaResponse", + "description": [ + "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" + ], "signature": [ { "pluginId": "core", @@ -3714,48 +4096,48 @@ }, "" ], - "description": [ - "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.IKibanaResponse.status", "type": "number", + "tags": [], "label": "status", "description": [], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 34 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IKibanaResponse.payload", "type": "Uncategorized", + "tags": [], "label": "payload", "description": [], + "signature": [ + "T | undefined" + ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 35 }, - "signature": [ - "T | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IKibanaResponse.options", "type": "Object", + "tags": [], "label": "options", "description": [], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 36 - }, "signature": [ { "pluginId": "core", @@ -3764,30 +4146,38 @@ "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" } - ] + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 36 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 33 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.IKibanaSocket", "type": "Interface", + "tags": [], "label": "IKibanaSocket", "description": [ "\nA tiny abstraction for TCP socket." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate", "type": "Function", + "tags": [], "label": "getPeerCertificate", + "description": [], "signature": [ "{ (detailed: true): ", "DetailedPeerCertificate", @@ -3799,34 +4189,39 @@ "PeerCertificate", " | null; }" ], - "description": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate.$1", "type": "boolean", + "tags": [], "label": "detailed", - "isRequired": true, + "description": [], "signature": [ "true" ], - "description": [], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 18 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate", "type": "Function", + "tags": [], "label": "getPeerCertificate", + "description": [], "signature": [ "{ (detailed: true): ", "DetailedPeerCertificate", @@ -3838,34 +4233,41 @@ "PeerCertificate", " | null; }" ], - "description": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate.$1", "type": "boolean", + "tags": [], "label": "detailed", - "isRequired": true, + "description": [], "signature": [ "false" ], - "description": [], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 19 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate", "type": "Function", + "tags": [], "label": "getPeerCertificate", + "description": [ + "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." + ], "signature": [ "{ (detailed: true): ", "DetailedPeerCertificate", @@ -3877,159 +4279,174 @@ "PeerCertificate", " | null; }" ], - "description": [ - "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." - ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate.$1", "type": "CompoundType", - "label": "detailed", - "isRequired": false, - "signature": [ - "boolean | undefined" - ], + "tags": [], + "label": "detailed", "description": [ "- If true; the full chain with issuer property will be returned." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [ "An object representing the peer's certificate." - ], - "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 29 - } + ] }, { + "parentPluginId": "core", "id": "def-server.IKibanaSocket.getProtocol", "type": "Function", + "tags": [], "label": "getProtocol", - "signature": [ - "() => string | null" - ], "description": [ "\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => string | null" + ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.IKibanaSocket.renegotiate", "type": "Function", + "tags": [], "label": "renegotiate", - "signature": [ - "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" - ], "description": [ "\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3." ], + "signature": [ + "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.IKibanaSocket.renegotiate.$1.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.IKibanaSocket.renegotiate.$1.options.rejectUnauthorized", "type": "CompoundType", + "tags": [], "label": "rejectUnauthorized", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 43 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IKibanaSocket.renegotiate.$1.options.requestCert", "type": "CompoundType", + "tags": [], "label": "requestCert", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 43 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 43 - } + ] } ], - "tags": [], "returnComment": [ "A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed." - ], - "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 43 - } + ] }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IKibanaSocket.authorized", "type": "CompoundType", + "tags": [], "label": "authorized", "description": [ "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 49 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IKibanaSocket.authorizationError", "type": "Object", + "tags": [], "label": "authorizationError", "description": [ "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." ], + "signature": [ + "Error | undefined" + ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 55 }, - "signature": [ - "Error | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.IRouter", "type": "Interface", + "tags": [], "label": "IRouter", + "description": [ + "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" + ], "signature": [ { "pluginId": "core", @@ -4040,38 +4457,36 @@ }, "" ], - "description": [ - "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.IRouter.routerPath", "type": "string", + "tags": [], "label": "routerPath", "description": [ "\nResulted path" ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 65 - } + "lineNumber": 66 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IRouter.get", "type": "Function", + "tags": [], "label": "get", "description": [ "\nRegister a route handler for `GET` request." ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 72 - }, "signature": [ { "pluginId": "core", @@ -4081,20 +4496,22 @@ "text": "RouteRegistrar" }, "<\"get\", Context>" - ] + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 73 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IRouter.post", "type": "Function", + "tags": [], "label": "post", "description": [ "\nRegister a route handler for `POST` request." ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 79 - }, "signature": [ { "pluginId": "core", @@ -4104,20 +4521,22 @@ "text": "RouteRegistrar" }, "<\"post\", Context>" - ] + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 80 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IRouter.put", "type": "Function", + "tags": [], "label": "put", "description": [ "\nRegister a route handler for `PUT` request." ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 86 - }, "signature": [ { "pluginId": "core", @@ -4127,20 +4546,22 @@ "text": "RouteRegistrar" }, "<\"put\", Context>" - ] + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 87 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IRouter.patch", "type": "Function", + "tags": [], "label": "patch", "description": [ "\nRegister a route handler for `PATCH` request." ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 93 - }, "signature": [ { "pluginId": "core", @@ -4150,20 +4571,22 @@ "text": "RouteRegistrar" }, "<\"patch\", Context>" - ] + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 94 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IRouter.delete", "type": "Function", + "tags": [], "label": "delete", "description": [ "\nRegister a route handler for `DELETE` request." ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 100 - }, "signature": [ { "pluginId": "core", @@ -4173,20 +4596,22 @@ "text": "RouteRegistrar" }, "<\"delete\", Context>" - ] + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 101 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.IRouter.handleLegacyErrors", "type": "Function", + "tags": [], "label": "handleLegacyErrors", "description": [ "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 106 - }, "signature": [ { "pluginId": "core", @@ -4195,71 +4620,81 @@ "section": "def-server.RequestHandlerWrapper", "text": "RequestHandlerWrapper" } - ] + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 107 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 61 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.KibanaRequestEvents", "type": "Interface", + "tags": [], "label": "KibanaRequestEvents", "description": [ "\nRequest events." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequestEvents.aborted$", "type": "Object", + "tags": [], "label": "aborted$", "description": [ "\nObservable that emits once if and when the request has been aborted." ], + "signature": [ + "Observable", + "" + ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 66 }, - "signature": [ - "Observable", - "" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequestEvents.completed$", "type": "Object", + "tags": [], "label": "completed$", "description": [ "\nObservable that emits once if and when the request has been completely handled.\n" ], + "signature": [ + "Observable", + "" + ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 76 }, - "signature": [ - "Observable", - "" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 62 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.KibanaRequestRoute", "type": "Interface", + "tags": [], "label": "KibanaRequestRoute", + "description": [ + "\nRequest specific route information exposed to a handler." + ], "signature": [ { "pluginId": "core", @@ -4270,48 +4705,48 @@ }, "" ], - "description": [ - "\nRequest specific route information exposed to a handler." - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 52 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequestRoute.path", "type": "string", + "tags": [], "label": "path", "description": [], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 53 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequestRoute.method", "type": "Uncategorized", + "tags": [], "label": "method", "description": [], + "signature": [ + "Method" + ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 54 }, - "signature": [ - "Method" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.KibanaRequestRoute.options", "type": "Uncategorized", + "tags": [], "label": "options", "description": [], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 55 - }, "signature": [ { "pluginId": "core", @@ -4321,19 +4756,25 @@ "text": "KibanaRequestRouteOptions" }, "" - ] + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 55 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 52 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LegacyRequest", "type": "Interface", + "tags": [ + "deprecated" + ], "label": "LegacyRequest", + "description": [], "signature": [ { "pluginId": "core", @@ -4345,176 +4786,203 @@ " extends ", "Request" ], - "description": [], - "tags": [ - "deprecated", - "public" + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 84 + }, + "deprecated": true, + "references": [ + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/server/saved_objects/index.ts", + "lineNumber": 8 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/server/saved_objects/index.ts", + "lineNumber": 34 + } + } ], "children": [], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 84 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPostAuthToolkit", "type": "Interface", + "tags": [], "label": "OnPostAuthToolkit", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OnPostAuthToolkit.next", "type": "Function", + "tags": [], "label": "next", "description": [ "To pass request to the next handler" ], + "signature": [ + "() => Next" + ], "source": { "path": "src/core/server/http/lifecycle/on_post_auth.ts", "lineNumber": 44 }, - "signature": [ - "() => Next" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "lineNumber": 42 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPreAuthToolkit", "type": "Interface", + "tags": [], "label": "OnPreAuthToolkit", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OnPreAuthToolkit.next", "type": "Function", + "tags": [], "label": "next", "description": [ "To pass request to the next handler" ], + "signature": [ + "() => Next" + ], "source": { "path": "src/core/server/http/lifecycle/on_pre_auth.ts", "lineNumber": 44 }, - "signature": [ - "() => Next" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "lineNumber": 42 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPreResponseExtensions", "type": "Interface", + "tags": [], "label": "OnPreResponseExtensions", "description": [ "\nAdditional data to extend a response." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OnPreResponseExtensions.headers", "type": "CompoundType", + "tags": [], "label": "headers", "description": [ "additional headers to attach to the response" ], + "signature": [ + "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" + ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 58 }, - "signature": [ - "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 56 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPreResponseInfo", "type": "Interface", + "tags": [], "label": "OnPreResponseInfo", "description": [ "\nResponse status code." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OnPreResponseInfo.statusCode", "type": "number", + "tags": [], "label": "statusCode", "description": [], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 66 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 65 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPreResponseRender", "type": "Interface", + "tags": [], "label": "OnPreResponseRender", "description": [ "\nAdditional data to extend a response when rendering a new body" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OnPreResponseRender.headers", "type": "CompoundType", + "tags": [], "label": "headers", "description": [ "additional headers to attach to the response" ], + "signature": [ + "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" + ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 47 }, - "signature": [ - "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OnPreResponseRender.body", "type": "string", + "tags": [], "label": "body", "description": [ "the body to use in the response" @@ -4522,38 +4990,36 @@ "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 49 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 45 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPreResponseToolkit", "type": "Interface", + "tags": [], "label": "OnPreResponseToolkit", "description": [ "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 88 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OnPreResponseToolkit.render", "type": "Function", + "tags": [], "label": "render", "description": [ "To override the response with a different body" ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 90 - }, "signature": [ "(responseRender: ", { @@ -4564,20 +5030,22 @@ "text": "OnPreResponseRender" }, ") => OnPreResponseResult" - ] + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 90 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OnPreResponseToolkit.next", "type": "Function", + "tags": [], "label": "next", "description": [ "To pass request to the next handler" ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 92 - }, "signature": [ "(responseExtensions?: ", { @@ -4588,67 +5056,77 @@ "text": "OnPreResponseExtensions" }, " | undefined) => OnPreResponseResult" - ] + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 92 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 88 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPreRoutingToolkit", "type": "Interface", + "tags": [], "label": "OnPreRoutingToolkit", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.OnPreRoutingToolkit.next", "type": "Function", + "tags": [], "label": "next", "description": [ "To pass request to the next handler" ], + "signature": [ + "() => OnPreRoutingResult" + ], "source": { "path": "src/core/server/http/lifecycle/on_pre_routing.ts", "lineNumber": 57 }, - "signature": [ - "() => OnPreRoutingResult" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.OnPreRoutingToolkit.rewriteUrl", "type": "Function", + "tags": [], "label": "rewriteUrl", "description": [ "Rewrite requested resources url before is was authenticated and routed to a handler" ], + "signature": [ + "(url: string) => OnPreRoutingResult" + ], "source": { "path": "src/core/server/http/lifecycle/on_pre_routing.ts", "lineNumber": 59 }, - "signature": [ - "(url: string) => OnPreRoutingResult" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "lineNumber": 55 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteConfig", "type": "Interface", + "tags": [], "label": "RouteConfig", + "description": [ + "\nRoute specific configuration." + ], "signature": [ { "pluginId": "core", @@ -4659,17 +5137,17 @@ }, "" ], - "description": [ - "\nRoute specific configuration." - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 157 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfig.path", "type": "string", + "tags": [], "label": "path", "description": [ "\nThe endpoint _within_ the router path to register the route.\n" @@ -4677,20 +5155,18 @@ "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 171 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfig.validate", "type": "CompoundType", + "tags": [], "label": "validate", "description": [ "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 229 - }, "signature": [ "false | ", { @@ -4701,20 +5177,22 @@ "text": "RouteValidatorFullConfig" }, "" - ] + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 229 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfig.options", "type": "Object", + "tags": [], "label": "options", "description": [ "\nAdditional route options {@link RouteConfigOptions}." ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 234 - }, "signature": [ { "pluginId": "core", @@ -4724,19 +5202,25 @@ "text": "RouteConfigOptions" }, " | undefined" - ] + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 234 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 157 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteConfigOptions", "type": "Interface", + "tags": [], "label": "RouteConfigOptions", + "description": [ + "\nAdditional route options." + ], "signature": [ { "pluginId": "core", @@ -4747,73 +5231,75 @@ }, "" ], - "description": [ - "\nAdditional route options." - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 106 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfigOptions.authRequired", "type": "CompoundType", + "tags": [], "label": "authRequired", "description": [ "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." ], + "signature": [ + "boolean | \"optional\" | undefined" + ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 116 }, - "signature": [ - "boolean | \"optional\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfigOptions.xsrfRequired", "type": "Uncategorized", + "tags": [], "label": "xsrfRequired", "description": [ "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" ], + "signature": [ + "(Method extends \"get\" ? never : boolean) | undefined" + ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 125 }, - "signature": [ - "(Method extends \"get\" ? never : boolean) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfigOptions.tags", "type": "Object", + "tags": [], "label": "tags", "description": [ "\nAdditional metadata tag strings to attach to the route." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 130 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfigOptions.body", "type": "Uncategorized", + "tags": [], "label": "body", "description": [ "\nAdditional body options {@link RouteConfigOptionsBody}." ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 135 - }, "signature": [ "(Method extends ", { @@ -4832,20 +5318,22 @@ "text": "RouteConfigOptionsBody" }, ") | undefined" - ] + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 135 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfigOptions.timeout", "type": "Object", + "tags": [], "label": "timeout", "description": [ "\nDefines per-route timeouts." ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 140 - }, "signature": [ "{ payload?: (Method extends ", { @@ -4856,38 +5344,40 @@ "text": "SafeRouteMethod" }, " ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" - ] + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 140 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 106 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteConfigOptionsBody", "type": "Interface", + "tags": [], "label": "RouteConfigOptionsBody", "description": [ "\nAdditional body options for a route" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfigOptionsBody.accepts", "type": "CompoundType", + "tags": [], "label": "accepts", "description": [ "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 68 - }, "signature": [ "string | string[] | ", { @@ -4898,98 +5388,108 @@ "text": "RouteContentType" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 68 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfigOptionsBody.maxBytes", "type": "number", + "tags": [], "label": "maxBytes", "description": [ - "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayloadBytes`." + "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." + ], + "signature": [ + "number | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 75 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfigOptionsBody.output", "type": "CompoundType", + "tags": [], "label": "output", "description": [ "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." ], + "signature": [ + "\"data\" | \"stream\" | undefined" + ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 88 }, - "signature": [ - "\"data\" | \"stream\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteConfigOptionsBody.parse", "type": "CompoundType", + "tags": [], "label": "parse", "description": [ "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." ], + "signature": [ + "boolean | \"gunzip\" | undefined" + ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 99 }, - "signature": [ - "boolean | \"gunzip\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 55 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteValidationResultFactory", "type": "Interface", + "tags": [], "label": "RouteValidationResultFactory", "description": [ "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteValidationResultFactory.ok", "type": "Function", + "tags": [], "label": "ok", "description": [], + "signature": [ + "(value: T) => { value: T; }" + ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 21 }, - "signature": [ - "(value: T) => { value: T; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.RouteValidationResultFactory.badRequest", "type": "Function", + "tags": [], "label": "badRequest", "description": [], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 22 - }, "signature": [ "(error: string | Error, path?: string[] | undefined) => { error: ", { @@ -5000,19 +5500,25 @@ "text": "RouteValidationError" }, "; }" - ] + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 22 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteValidatorConfig", "type": "Interface", + "tags": [], "label": "RouteValidatorConfig", + "description": [ + "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" + ], "signature": [ { "pluginId": "core", @@ -5023,27 +5529,21 @@ }, "" ], - "description": [ - "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 87 + }, + "deprecated": false, "children": [ { - "tags": [ - "public" - ], + "parentPluginId": "core", "id": "def-server.RouteValidatorConfig.params", "type": "CompoundType", + "tags": [], "label": "params", "description": [ "\nValidation logic for the URL params" ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 92 - }, "signature": [ "ObjectType", " | ", @@ -5057,22 +5557,22 @@ "text": "RouteValidationFunction" }, "

| undefined" - ] + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 92 + }, + "deprecated": false }, { - "tags": [ - "public" - ], + "parentPluginId": "core", "id": "def-server.RouteValidatorConfig.query", "type": "CompoundType", + "tags": [], "label": "query", "description": [ "\nValidation logic for the Query params" ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 97 - }, "signature": [ "ObjectType", " | ", @@ -5086,22 +5586,22 @@ "text": "RouteValidationFunction" }, " | undefined" - ] + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 97 + }, + "deprecated": false }, { - "tags": [ - "public" - ], + "parentPluginId": "core", "id": "def-server.RouteValidatorConfig.body", "type": "CompoundType", + "tags": [], "label": "body", "description": [ "\nValidation logic for the body payload" ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 102 - }, "signature": [ "ObjectType", " | ", @@ -5115,66 +5615,72 @@ "text": "RouteValidationFunction" }, " | undefined" - ] + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 102 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 87 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteValidatorOptions", "type": "Interface", + "tags": [], "label": "RouteValidatorOptions", "description": [ "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 110 + }, + "deprecated": false, "children": [ { - "tags": [ - "public" - ], + "parentPluginId": "core", "id": "def-server.RouteValidatorOptions.unsafe", "type": "Object", + "tags": [], "label": "unsafe", "description": [ "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" ], + "signature": [ + "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" + ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 115 }, - "signature": [ - "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 110 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SessionCookieValidationResult", "type": "Interface", + "tags": [], "label": "SessionCookieValidationResult", "description": [ "\nReturn type from a function to validate cookie contents." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SessionCookieValidationResult.isValid", "type": "boolean", + "tags": [], "label": "isValid", "description": [ "\nWhether the cookie is valid or not." @@ -5182,35 +5688,39 @@ "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 52 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SessionCookieValidationResult.path", "type": "string", + "tags": [], "label": "path", "description": [ "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 56 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SessionStorage", "type": "Interface", + "tags": [], "label": "SessionStorage", + "description": [ + "\nProvides an interface to store and retrieve data across requests." + ], "signature": [ { "pluginId": "core", @@ -5221,95 +5731,104 @@ }, "" ], - "description": [ - "\nProvides an interface to store and retrieve data across requests." - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SessionStorage.get", "type": "Function", + "tags": [], "label": "get", - "signature": [ - "() => Promise" - ], "description": [ "\nRetrieves session value from the session storage." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => Promise" + ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SessionStorage.set", "type": "Function", + "tags": [], "label": "set", - "signature": [ - "(sessionValue: T) => void" - ], "description": [ "\nPuts current session value into the session storage." ], + "signature": [ + "(sessionValue: T) => void" + ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SessionStorage.set.$1", "type": "Uncategorized", + "tags": [], "label": "sessionValue", - "isRequired": true, - "signature": [ - "T" - ], "description": [ "- value to put" ], + "signature": [ + "T" + ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 23 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SessionStorage.clear", "type": "Function", + "tags": [], "label": "clear", - "signature": [ - "() => void" - ], "description": [ "\nClears current session." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions", "type": "Interface", + "tags": [], "label": "SessionStorageCookieOptions", + "description": [ + "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." + ], "signature": [ { "pluginId": "core", @@ -5320,17 +5839,17 @@ }, "" ], - "description": [ - "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nName of the session cookie." @@ -5338,12 +5857,14 @@ "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions.encryptionKey", "type": "string", + "tags": [], "label": "encryptionKey", "description": [ "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." @@ -5351,20 +5872,18 @@ "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions.validate", "type": "Function", + "tags": [], "label": "validate", "description": [ "\nFunction called to validate a cookie's decrypted value." ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 32 - }, "signature": [ "(sessionValue: T | T[]) => ", { @@ -5374,12 +5893,18 @@ "section": "def-server.SessionCookieValidationResult", "text": "SessionCookieValidationResult" } - ] + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 32 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions.isSecure", "type": "boolean", + "tags": [], "label": "isSecure", "description": [ "\nFlag indicating whether the cookie should be sent only via a secure connection." @@ -5387,35 +5912,39 @@ "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 36 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions.sameSite", "type": "CompoundType", + "tags": [], "label": "sameSite", "description": [ "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" ], + "signature": [ + "\"None\" | \"Strict\" | \"Lax\" | undefined" + ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 41 }, - "signature": [ - "\"None\" | \"Strict\" | \"Lax\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SessionStorageFactory", "type": "Interface", + "tags": [], "label": "SessionStorageFactory", + "description": [ + "\nSessionStorage factory to bind one to an incoming request" + ], "signature": [ { "pluginId": "core", @@ -5426,23 +5955,19 @@ }, "" ], - "description": [ - "\nSessionStorage factory to bind one to an incoming request" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SessionStorageFactory.asScoped", "type": "Function", + "tags": [], "label": "asScoped", "description": [], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 34 - }, "signature": [ "(request: ", { @@ -5461,38 +5986,38 @@ "text": "SessionStorage" }, "" - ] + ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 34 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 33 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "core", "id": "def-server.AuthResultType", "type": "Enum", + "tags": [], "label": "AuthResultType", - "tags": [ - "public" - ], "description": [], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 22 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.AuthStatus", "type": "Enum", + "tags": [], "label": "AuthStatus", - "tags": [ - "public" - ], "description": [ "\nStatus indicating an outcome of the authentication." ], @@ -5500,24 +6025,20 @@ "path": "src/core/server/http/auth_state_storage.ts", "lineNumber": 15 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "core", "id": "def-server.AuthenticationHandler", "type": "Type", + "tags": [], "label": "AuthenticationHandler", - "tags": [ - "public" - ], "description": [ "\nSee {@link AuthToolkit}." ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 147 - }, "signature": [ "(request: ", { @@ -5554,39 +6075,39 @@ "text": "ErrorHttpResponseOptions" } ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 147 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.AuthHeaders", "type": "Type", + "tags": [], "label": "AuthHeaders", - "tags": [ - "public" - ], "description": [ "\nAuth Headers map" ], + "signature": [ + "{ [x: string]: string | string[]; }" + ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 82 }, - "signature": [ - "{ [x: string]: string | string[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.AuthResult", "type": "Type", + "tags": [], "label": "AuthResult", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 44 - }, "signature": [ { "pluginId": "core", @@ -5612,42 +6133,43 @@ "text": "AuthRedirected" } ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 44 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.DestructiveRouteMethod", "type": "Type", + "tags": [], "label": "DestructiveRouteMethod", - "tags": [ - "public" - ], "description": [ "\nSet of HTTP methods changing the state of the server." ], + "signature": [ + "\"post\" | \"put\" | \"delete\" | \"patch\"" + ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 19 }, - "signature": [ - "\"post\" | \"put\" | \"delete\" | \"patch\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.GetAuthHeaders", "type": "Type", - "label": "GetAuthHeaders", "tags": [ - "return", - "public" + "return" ], + "label": "GetAuthHeaders", "description": [ "\nGet headers to authenticate a user against Elasticsearch." ], - "source": { - "path": "src/core/server/http/auth_headers_storage.ts", - "lineNumber": 18 - }, "signature": [ "(request: ", { @@ -5667,22 +6189,22 @@ }, ") => Record | undefined" ], + "source": { + "path": "src/core/server/http/auth_headers_storage.ts", + "lineNumber": 18 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.GetAuthState", "type": "Type", + "tags": [], "label": "GetAuthState", - "tags": [ - "public" - ], "description": [ "\nGets authentication state for a request. Returned by `auth` interceptor." ], - "source": { - "path": "src/core/server/http/auth_state_storage.ts", - "lineNumber": 35 - }, "signature": [ "(request: ", { @@ -5710,80 +6232,80 @@ }, "; state: T; }" ], + "source": { + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 35 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.Headers", "type": "Type", + "tags": [], "label": "Headers", - "tags": [ - "public" - ], "description": [ "\nHttp request headers to read." ], + "signature": [ + "{ accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; date?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; from?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; warning?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], "source": { "path": "src/core/server/http/router/headers.ts", "lineNumber": 40 }, - "signature": [ - "{ accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; date?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; from?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; warning?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.HttpResponsePayload", "type": "Type", + "tags": [], "label": "HttpResponsePayload", - "tags": [ - "public" - ], "description": [ "\nData send to the client as a response payload." ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 71 - }, "signature": [ "undefined | string | Record | Buffer | ", "Stream" ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 73 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.IBasePath", "type": "Type", + "tags": [], "label": "IBasePath", - "tags": [ - "public" - ], "description": [ "\nAccess or manipulate the Kibana base path\n\n{@link BasePath}" ], + "signature": [ + "{ remove: (path: string) => string; get: (request: KibanaRequest | LegacyRequest) => string; prepend: (path: string) => string; set: (request: KibanaRequest | LegacyRequest, requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" + ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 104 }, - "signature": [ - "{ remove: (path: string) => string; get: (request: KibanaRequest | LegacyRequest) => string; prepend: (path: string) => string; set: (request: KibanaRequest | LegacyRequest, requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.IsAuthenticated", "type": "Type", + "tags": [], "label": "IsAuthenticated", - "tags": [ - "public" - ], "description": [ "\nReturns authentication status for a request." ], - "source": { - "path": "src/core/server/http/auth_state_storage.ts", - "lineNumber": 44 - }, "signature": [ "(request: ", { @@ -5803,22 +6325,22 @@ }, ") => boolean" ], + "source": { + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 44 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.KibanaRequestRouteOptions", "type": "Type", + "tags": [], "label": "KibanaRequestRouteOptions", - "tags": [ - "public" - ], "description": [ "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 44 - }, "signature": [ "Method extends ", { @@ -5830,79 +6352,79 @@ }, " ? Required, \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required>" ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 44 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.KibanaResponseFactory", "type": "Type", + "tags": [], "label": "KibanaResponseFactory", - "tags": [ - "public" - ], "description": [ "\nCreates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client." ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 319 - }, "signature": [ "{ custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | Stream | undefined>(options: CustomHttpResponseOptions) => KibanaResponse; badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse; unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse; forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse; notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse; conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse; customError: (options: CustomHttpResponseOptions) => KibanaResponse; redirected: (options: RedirectResponseOptions) => KibanaResponse | Buffer | Stream>; ok: (options?: HttpResponseOptions) => KibanaResponse | Buffer | Stream>; accepted: (options?: HttpResponseOptions) => KibanaResponse | Buffer | Stream>; noContent: (options?: HttpResponseOptions) => KibanaResponse; }" ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 323 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.KnownHeaders", "type": "Type", + "tags": [], "label": "KnownHeaders", - "tags": [ - "public" - ], "description": [ "\nSet of well-known HTTP headers." ], + "signature": [ + "\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\"" + ], "source": { "path": "src/core/server/http/router/headers.ts", "lineNumber": 34 }, - "signature": [ - "\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.LifecycleResponseFactory", "type": "Type", + "tags": [], "label": "LifecycleResponseFactory", - "tags": [ - "public" - ], "description": [ "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 325 - }, "signature": [ "{ badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse; unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse; forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse; notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse; conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse; customError: (options: CustomHttpResponseOptions) => KibanaResponse; redirected: (options: RedirectResponseOptions) => KibanaResponse | Buffer | Stream>; }" ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 329 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPostAuthHandler", "type": "Type", + "tags": [], "label": "OnPostAuthHandler", - "tags": [ - "public" - ], "description": [ "\nSee {@link OnPostAuthToolkit}." ], - "source": { - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "lineNumber": 51 - }, "signature": [ "(request: ", { @@ -5939,22 +6461,22 @@ "text": "ErrorHttpResponseOptions" } ], + "source": { + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "lineNumber": 51 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPreAuthHandler", "type": "Type", + "tags": [], "label": "OnPreAuthHandler", - "tags": [ - "public" - ], "description": [ "\nSee {@link OnPreAuthToolkit}." ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "lineNumber": 55 - }, "signature": [ "(request: ", { @@ -5991,22 +6513,22 @@ "text": "ErrorHttpResponseOptions" } ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "lineNumber": 55 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPreResponseHandler", "type": "Type", + "tags": [], "label": "OnPreResponseHandler", - "tags": [ - "public" - ], "description": [ "\nSee {@link OnPreRoutingToolkit}." ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 104 - }, "signature": [ "(request: ", { @@ -6034,22 +6556,22 @@ }, ") => Render | Next | Promise" ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 104 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.OnPreRoutingHandler", "type": "Type", + "tags": [], "label": "OnPreRoutingHandler", - "tags": [ - "public" - ], "description": [ "\nSee {@link OnPreRoutingToolkit}." ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "lineNumber": 71 - }, "signature": [ "(request: ", { @@ -6086,41 +6608,41 @@ "text": "ErrorHttpResponseOptions" } ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 71 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RedirectResponseOptions", "type": "Type", + "tags": [], "label": "RedirectResponseOptions", - "tags": [ - "public" - ], "description": [ "\nHTTP response parameters for redirection response" ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 89 - }, "signature": [ "HttpResponseOptions & { headers: { location: string;}; }" ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 93 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RequestHandler", "type": "Type", + "tags": [], "label": "RequestHandler", - "tags": [ - "public" - ], "description": [ "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 350 - }, "signature": [ "(context: Context, request: ", { @@ -6148,41 +6670,41 @@ }, ">" ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 351 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RequestHandlerContextContainer", "type": "Type", + "tags": [], "label": "RequestHandlerContextContainer", - "tags": [ - "public" - ], "description": [ "\nAn object that handles registration of http request context providers." ], + "signature": [ + "IContextContainer" + ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 30 }, - "signature": [ - "IContextContainer" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RequestHandlerContextProvider", "type": "Type", + "tags": [], "label": "RequestHandlerContextProvider", - "tags": [ - "public" - ], "description": [ "\nContext provider for request handler.\nExtends request context object with provided functionality or data.\n" ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 38 - }, "signature": [ "(context: Pick>, rest: [request: ", { @@ -6213,22 +6735,22 @@ "text": "ErrorHttpResponseOptions" } ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 38 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RequestHandlerWrapper", "type": "Type", + "tags": [], "label": "RequestHandlerWrapper", - "tags": [ - "public" - ], "description": [ "\nType-safe wrapper for {@link RequestHandler} function." ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 376 - }, "signature": [ "(handler: ", { @@ -6248,117 +6770,117 @@ }, "" ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 377 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ResponseError", "type": "Type", + "tags": [], "label": "ResponseError", - "tags": [ - "public" - ], "description": [ "\nError message and optional data send to the client in case of error." ], + "signature": [ + "string | Error | { message: string | Error; attributes?: Record | undefined; }" + ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 21 }, - "signature": [ - "string | Error | { message: string | Error; attributes?: Record | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ResponseErrorAttributes", "type": "Type", + "tags": [], "label": "ResponseErrorAttributes", - "tags": [ - "public" - ], "description": [ "\nAdditional data to provide error details." ], + "signature": [ + "{ [x: string]: any; }" + ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 16 }, - "signature": [ - "{ [x: string]: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ResponseHeaders", "type": "Type", + "tags": [], "label": "ResponseHeaders", - "tags": [ - "public" - ], "description": [ "\nHttp response headers to set." ], + "signature": [ + "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record" + ], "source": { "path": "src/core/server/http/router/headers.ts", "lineNumber": 48 }, - "signature": [ - "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteContentType", "type": "Type", + "tags": [], "label": "RouteContentType", - "tags": [ - "public" - ], "description": [ "\nThe set of supported parseable Content-Types" ], + "signature": [ + "\"application/json\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"multipart/form-data\" | \"text/*\"" + ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 43 }, - "signature": [ - "\"application/json\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"multipart/form-data\" | \"text/*\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteMethod", "type": "Type", + "tags": [], "label": "RouteMethod", - "tags": [ - "public" - ], "description": [ "\nThe set of common HTTP methods supported by Kibana routing." ], + "signature": [ + "\"get\" | \"options\" | \"post\" | \"put\" | \"delete\" | \"patch\"" + ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 31 }, - "signature": [ - "\"get\" | \"options\" | \"post\" | \"put\" | \"delete\" | \"patch\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteRegistrar", "type": "Type", + "tags": [], "label": "RouteRegistrar", - "tags": [ - "public" - ], "description": [ "\nRoute handler common definition\n" ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 47 - }, "signature": [ "(route: ", { @@ -6389,22 +6911,22 @@ ") => ", "KibanaResponse" ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 48 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteValidationFunction", "type": "Type", + "tags": [], "label": "RouteValidationFunction", - "tags": [ - "public" - ], "description": [ "\nThe custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements.\n" ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 50 - }, "signature": [ "(data: any, validationResult: ", { @@ -6424,22 +6946,22 @@ }, "; }" ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 50 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteValidationSpec", "type": "Type", + "tags": [], "label": "RouteValidationSpec", - "tags": [ - "public" - ], "description": [ "\nAllowed property validation options: either @kbn/config-schema validations or custom validation functions\n\nSee {@link RouteValidationFunction} for custom validation.\n" ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 70 - }, "signature": [ "ObjectType", " | ", @@ -6454,122 +6976,124 @@ }, "" ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 70 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.RouteValidatorFullConfig", "type": "Type", + "tags": [], "label": "RouteValidatorFullConfig", - "tags": [ - "public" - ], "description": [ "\nRoute validations config and options merged into one object" ], + "signature": [ + "RouteValidatorConfig & RouteValidatorOptions" + ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 126 }, - "signature": [ - "RouteValidatorConfig & RouteValidatorOptions" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SafeRouteMethod", "type": "Type", + "tags": [], "label": "SafeRouteMethod", - "tags": [ - "public" - ], "description": [ "\nSet of HTTP methods not changing the state of the server." ], + "signature": [ + "\"get\" | \"options\"" + ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 25 }, - "signature": [ - "\"get\" | \"options\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "core", "id": "def-server.kibanaResponseFactory", "type": "Object", - "tags": [ - "public" + "tags": [], + "label": "kibanaResponseFactory", + "description": [ + "\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n" ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 293 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.kibanaResponseFactory.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 290 + "lineNumber": 294 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.kibanaResponseFactory.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 291 + "lineNumber": 295 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.kibanaResponseFactory.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 292 + "lineNumber": 296 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.kibanaResponseFactory.custom", "type": "Function", - "children": [ - { - "id": "def-server.kibanaResponseFactory.custom.$1", - "type": "Object", - "label": "options", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "" - ], - "description": [], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 298 - } - } + "tags": [], + "label": "custom", + "description": [ + "/**\n * Creates a response with defined status code and payload.\n * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters.\n */" ], "signature": [ " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", @@ -6586,45 +7110,59 @@ "KibanaResponse", "" ], - "description": [ - "/**\n * Creates a response with defined status code and payload.\n * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters.\n */" - ], - "label": "custom", "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 297 + "lineNumber": 301 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.kibanaResponseFactory.custom.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 302 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } ], - "description": [ - "\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n" - ], - "label": "kibanaResponseFactory", - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 289 - }, "initialIsOpen": false }, { - "tags": [ - "public" - ], + "parentPluginId": "core", "id": "def-server.validBodyOutput", "type": "Object", + "tags": [], "label": "validBodyOutput", "description": [ "\nThe set of valid body.output" ], + "signature": [ + "readonly [\"data\", \"stream\"]" + ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 37 }, - "signature": [ - "readonly [\"data\", \"stream\"]" - ], + "deprecated": false, "initialIsOpen": false } ] diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json index 693916de32d3a..c2d2dff35c9dd 100644 --- a/api_docs/core_saved_objects.json +++ b/api_docs/core_saved_objects.json @@ -3,53 +3,95 @@ "client": { "classes": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectsClient", "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" ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 166 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.create", "type": "Function", + "tags": [], + "label": "create", + "description": [ + "\nPersists an object\n" + ], + "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" + }, + ">" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 221 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.create.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 221 - } + "lineNumber": 222 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.create.$2", "type": "Uncategorized", + "tags": [], "label": "attributes", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 222 - } + "lineNumber": 223 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.create.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -59,52 +101,67 @@ "text": "SavedObjectsCreateOptions" } ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 223 - } + "lineNumber": 224 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClient.bulkCreate", + "type": "Function", + "tags": [ + "property" + ], + "label": "bulkCreate", + "description": [ + "\nCreates multiple documents at once\n" + ], "signature": [ - "(type: string, attributes: T, options?: ", + "(objects?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "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.SimpleSavedObject", - "text": "SimpleSavedObject" + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" }, - ">" - ], - "description": [ - "\nPersists an object\n" + ">" ], - "label": "create", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 220 + "lineNumber": 256 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.SavedObjectsClient.bulkCreate", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.bulkCreate.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -115,17 +172,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 256 - } + "lineNumber": 257 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.bulkCreate.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -135,128 +195,142 @@ "text": "SavedObjectsBulkCreateOptions" } ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 257 - } + "lineNumber": 258 + }, + "deprecated": false, + "isRequired": true } ], - "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" - }, - ">" - ], - "description": [ - "\nCreates multiple documents at once\n" - ], - "label": "bulkCreate", - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 255 - }, - "tags": [ - "property" - ], "returnComment": [ "The result of the create operation containing created saved objects." ] }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.delete", "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nDeletes an object\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + "SavedObjectsDeleteOptions", + " | undefined) => Promise<{}>" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 284 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.delete.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 284 - } + "lineNumber": 285 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.delete.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 285 - } + "lineNumber": 286 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.delete.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ "SavedObjectsDeleteOptions", " | undefined" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 286 - } + "lineNumber": 287 + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(type: string, id: string, options?: ", - "SavedObjectsDeleteOptions", - " | undefined) => Promise<{}>" + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClient.find", + "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property" ], + "label": "find", "description": [ - "\nDeletes an object\n" + "\nSearch for objects\n" + ], + "signature": [ + "(options: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\">) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsFindResponsePublic", + "text": "SavedObjectsFindResponsePublic" + }, + ">" ], - "label": "delete", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 283 + "lineNumber": 314 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.SavedObjectsClient.find", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.find.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -266,124 +340,93 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">" + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\">" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 314 - } + "lineNumber": 315 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "A find result with objects matching the specified search." + ] + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClient.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nFetches a single object\n" + ], "signature": [ - "(options: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<", + "(type: string, id: string) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsFindResponsePublic", - "text": "SavedObjectsFindResponsePublic" + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" }, ">" ], - "description": [ - "\nSearch for objects\n" - ], - "label": "find", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 313 + "lineNumber": 381 }, - "tags": [ - "property" - ], - "returnComment": [ - "A find result with objects matching the specified search." - ] - }, - { - "id": "def-public.SavedObjectsClient.get", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.get.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 372 - } + "lineNumber": 381 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.get.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 372 - } + "lineNumber": 381 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">" - ], - "description": [ - "\nFetches a single object\n" - ], - "label": "get", - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 372 - }, - "tags": [], "returnComment": [ "The saved object for the given type and id." ] }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.bulkGet", "type": "Function", - "children": [ - { - "id": "def-public.SavedObjectsClient.bulkGet.$1", - "type": "Array", - "label": "objects", - "isRequired": true, - "signature": [ - "{ id: string; type: string; }[]" - ], - "description": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 395 - } - } + "tags": [], + "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" ], "signature": [ "(objects?: { id: string; type: string; }[]) => Promise<", @@ -396,25 +439,48 @@ }, ">" ], - "description": [ - "\nReturns an array of objects by id\n" - ], - "label": "bulkGet", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 395 + "lineNumber": 404 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClient.bulkGet.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "{ id: string; type: string; }[]" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 404 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [ "The saved objects with the given type and ids requested" ] }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.update", "type": "Function", + "tags": [ + "prop", + "prop" + ], "label": "update", + "description": [ + "\nUpdates an object\n" + ], "signature": [ - "(type: string, id: string, attributes: T, { version, migrationVersion, references }?: ", + "(type: string, id: string, attributes: T, { version, references, upsert }?: ", { "pluginId": "core", "scope": "public", @@ -422,7 +488,7 @@ "section": "def-public.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, - ") => Promise<", + ") => Promise<", { "pluginId": "core", "scope": "public", @@ -432,57 +498,70 @@ }, ">" ], - "description": [ - "\nUpdates an object\n" - ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 435 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.update.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 427 - } + "lineNumber": 436 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.update.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 428 - } + "lineNumber": 437 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.update.$3", "type": "Uncategorized", + "tags": [], "label": "attributes", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 429 - } + "lineNumber": 438 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.update.$4", "type": "Object", - "label": "{ version, migrationVersion, references }", - "isRequired": true, + "tags": [], + "label": "{ version, references, upsert }", + "description": [], "signature": [ { "pluginId": "core", @@ -490,28 +569,28 @@ "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" - } + }, + "" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 430 - } + "lineNumber": 439 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "prop" - ], - "returnComment": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 426 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.bulkUpdate", "type": "Function", + "tags": [], "label": "bulkUpdate", + "description": [ + "\nUpdate multiple documents at once\n" + ], "signature": [ "(objects?: ", { @@ -531,15 +610,21 @@ }, ">" ], - "description": [ - "\nUpdate multiple documents at once\n" - ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 467 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.bulkUpdate.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [ + "- [{ type, id, attributes, options: { version, references } }]" + ], "signature": [ { "pluginId": "core", @@ -550,37 +635,26 @@ }, "[]" ], - "description": [ - "- [{ type, id, attributes, options: { version, references } }]" - ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 458 - } + "lineNumber": 467 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "The result of the update operation containing both failed and updated saved objects." - ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 458 - } + ] } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 165 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject", "type": "Class", - "tags": [ - "public" - ], + "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" @@ -595,130 +669,160 @@ }, "" ], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.attributes", "type": "Uncategorized", + "tags": [], "label": "attributes", "description": [], + "signature": [ + "T" + ], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 24 }, - "signature": [ - "T" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SimpleSavedObject._version", "type": "string", + "tags": [], "label": "_version", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 26 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 27 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.migrationVersion", "type": "Object", + "tags": [], "label": "migrationVersion", "description": [], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 29 }, - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.coreMigrationVersion", "type": "string", + "tags": [], "label": "coreMigrationVersion", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 30 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.error", "type": "Object", + "tags": [], "label": "error", "description": [], + "signature": [ + "SavedObjectError", + " | undefined" + ], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 31 }, - "signature": [ - "SavedObjectError", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.references", "type": "Array", + "tags": [], "label": "references", "description": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 32 - }, "signature": [ "SavedObjectReference", "[]" - ] + ], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 32 + }, + "deprecated": false }, { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.Unnamed.$1", "type": "Object", + "tags": [], "label": "client", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -730,146 +834,166 @@ }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">" ], - "description": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.Unnamed.$2", "type": "Object", + "tags": [], "label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n }", - "isRequired": true, + "description": [], "signature": [ "SavedObject", "" ], - "description": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 34 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(key: string) => any" ], - "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.get.$1", "type": "string", + "tags": [], "label": "key", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 59 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.set", "type": "Function", + "tags": [], "label": "set", + "description": [], "signature": [ "(key: string, value: any) => T" ], - "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.set.$1", "type": "string", + "tags": [], "label": "key", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 63 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.set.$2", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 63 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 63 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.has", "type": "Function", + "tags": [], "label": "has", + "description": [], "signature": [ "(key: string) => boolean" ], - "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 67 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.has.$1", "type": "string", + "tags": [], "label": "key", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 67 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 67 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.save", "type": "Function", + "tags": [], "label": "save", + "description": [], "signature": [ "() => Promise<", { @@ -881,45 +1005,45 @@ }, ">" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 71 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.SimpleSavedObject.delete", "type": "Function", + "tags": [], "label": "delete", + "description": [], "signature": [ "() => Promise<{}>" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 86 - } + "lineNumber": 85 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 23 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsBatchResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsBatchResponse", + "description": [], "signature": [ { "pluginId": "core", @@ -930,21 +1054,19 @@ }, "" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 87 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBatchResponse.savedObjects", "type": "Array", + "tags": [], "label": "savedObjects", "description": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 89 - }, "signature": [ { "pluginId": "core", @@ -954,19 +1076,23 @@ "text": "SimpleSavedObject" }, "[]" - ] + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 88 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 88 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkCreateObject", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkCreateObject", + "description": [], "signature": [ { "pluginId": "core", @@ -984,79 +1110,85 @@ "text": "SavedObjectsCreateOptions" } ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkCreateObject.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkCreateObject.attributes", "type": "Uncategorized", + "tags": [], "label": "attributes", "description": [], + "signature": [ + "T" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 56 }, - "signature": [ - "T" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkCreateOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkCreateOptions", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkCreateOptions.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" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 62 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 60 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkUpdateObject", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkUpdateObject", + "description": [], "signature": [ { "pluginId": "core", @@ -1067,213 +1199,237 @@ }, "" ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 66 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkUpdateObject.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 67 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkUpdateObject.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 68 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkUpdateObject.attributes", "type": "Uncategorized", + "tags": [], "label": "attributes", "description": [], + "signature": [ + "T" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 69 }, - "signature": [ - "T" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkUpdateObject.version", "type": "string", + "tags": [], "label": "version", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 70 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkUpdateObject.references", "type": "Array", + "tags": [], "label": "references", "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 71 }, - "signature": [ - "SavedObjectReference", - "[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 66 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkUpdateOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkUpdateOptions", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 75 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkUpdateOptions.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 76 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 75 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsCreateOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsCreateOptions", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "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" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 38 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 40 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsCreateOptions.migrationVersion", "type": "Object", + "tags": [], "label": "migrationVersion", "description": [ "{@inheritDoc SavedObjectsMigrationVersion}" ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 42 }, - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 44 - }, - "signature": [ - "string | undefined" - ] + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsCreateOptions.references", "type": "Array", + "tags": [], "label": "references", "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 45 }, - "signature": [ - "SavedObjectReference", - "[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 34 - }, "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", @@ -1282,7 +1438,7 @@ "section": "def-public.SavedObjectsFindResponsePublic", "text": "SavedObjectsFindResponsePublic" }, - " extends ", + " extends ", { "pluginId": "core", "scope": "public", @@ -1292,74 +1448,92 @@ }, "" ], - "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" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 105 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindResponsePublic.aggregations", + "type": "Uncategorized", "tags": [], + "label": "aggregations", + "description": [], + "signature": [ + "A | undefined" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 107 + }, + "deprecated": false + }, + { + "parentPluginId": "core", "id": "def-public.SavedObjectsFindResponsePublic.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 107 - } + "lineNumber": 108 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindResponsePublic.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 108 - } + "lineNumber": 109 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsFindResponsePublic.page", "type": "number", + "tags": [], "label": "page", "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 109 - } + "lineNumber": 110 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 106 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsStart", "type": "Interface", + "tags": [], "label": "SavedObjectsStart", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_service.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsStart.client", "type": "Object", + "tags": [], "label": "client", "description": [ "{@link SavedObjectsClient}" ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_service.ts", - "lineNumber": 18 - }, "signature": [ "Pick<", { @@ -1370,97 +1544,111 @@ "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">" - ] + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_service.ts", + "lineNumber": 18 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_service.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsUpdateOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsUpdateOptions", "description": [], - "tags": [ - "public" + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + "" ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsUpdateOptions.version", "type": "string", + "tags": [], "label": "version", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 81 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-public.SavedObjectsUpdateOptions.upsert", + "type": "Uncategorized", "tags": [], - "id": "def-public.SavedObjectsUpdateOptions.migrationVersion", - "type": "Object", - "label": "migrationVersion", - "description": [ - "{@inheritDoc SavedObjectsMigrationVersion}" + "label": "upsert", + "description": [], + "signature": [ + "Attributes | undefined" ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 83 + "lineNumber": 82 }, - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsUpdateOptions.references", "type": "Array", + "tags": [], "label": "references", "description": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 84 - }, "signature": [ "SavedObjectReference", "[] | undefined" - ] + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 83 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 80 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "core", "id": "def-public.SavedObjectsClientContract", "type": "Type", + "tags": [], "label": "SavedObjectsClientContract", - "tags": [ - "public" - ], "description": [ "\nSavedObjectsClientContract as implemented by the {@link SavedObjectsClient}\n" ], + "signature": [ + "{ get: (type: string, id: string) => Promise>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions | undefined) => Promise<{}>; create: (type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise>; bulkCreate: (objects?: SavedObjectsBulkCreateObject[], options?: SavedObjectsBulkCreateOptions) => Promise>; find: (options: Pick) => Promise>; bulkGet: (objects?: { id: string; type: string; }[]) => Promise>; update: (type: string, id: string, attributes: T, { version, references, upsert }?: SavedObjectsUpdateOptions) => Promise>; bulkUpdate: (objects?: SavedObjectsBulkUpdateObject[]) => Promise>; }" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 138 + "lineNumber": 139 }, - "signature": [ - "{ get: (type: string, id: string) => Promise>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions | undefined) => Promise<{}>; create: (type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise>; bulkCreate: (objects?: SavedObjectsBulkCreateObject[], options?: SavedObjectsBulkCreateOptions) => Promise>; find: (options: Pick) => Promise>; bulkGet: (objects?: { id: string; type: string; }[]) => Promise>; update: (type: string, id: string, attributes: T, { version, migrationVersion, references }?: SavedObjectsUpdateOptions) => Promise>; bulkUpdate: (objects?: SavedObjectsBulkUpdateObject[]) => Promise>; }" - ], + "deprecated": false, "initialIsOpen": false } ], @@ -1469,26 +1657,27 @@ "server": { "classes": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectsClient", "description": [ "\n" ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 404 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.errors", "type": "Object", + "tags": [], "label": "errors", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 402 - }, "signature": [ "typeof ", { @@ -1498,18 +1687,20 @@ "section": "def-server.SavedObjectsErrorHelpers", "text": "SavedObjectsErrorHelpers" } - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 405 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.errors", "type": "Object", + "tags": [], "label": "errors", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 403 - }, "signature": [ "typeof ", { @@ -1519,12 +1710,22 @@ "section": "def-server.SavedObjectsErrorHelpers", "text": "SavedObjectsErrorHelpers" } - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 406 + }, + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.create", "type": "Function", + "tags": [], "label": "create", + "description": [ + "\nPersists a SavedObject\n" + ], "signature": [ "(type: string, attributes: T, options?: ", { @@ -1538,43 +1739,53 @@ "SavedObject", ">" ], - "description": [ - "\nPersists a SavedObject\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 422 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.create.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 419 - } + "lineNumber": 422 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.create.$2", "type": "Uncategorized", + "tags": [], "label": "attributes", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 419 - } + "lineNumber": 422 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.create.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -1585,24 +1796,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 419 - } + "lineNumber": 422 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 419 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkCreate", "type": "Function", + "tags": [], "label": "bulkCreate", + "description": [ + "\nPersists multiple documents batched together as a single request\n" + ], "signature": [ "(objects: ", { @@ -1630,15 +1842,19 @@ }, ">" ], - "description": [ - "\nPersists multiple documents batched together as a single request\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 432 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkCreate.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1649,17 +1865,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 430 - } + "lineNumber": 433 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkCreate.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -1670,24 +1889,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 431 - } + "lineNumber": 434 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 429 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.checkConflicts", "type": "Function", + "tags": [], "label": "checkConflicts", + "description": [ + "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten.\n" + ], "signature": [ "(objects?: ", { @@ -1715,15 +1935,19 @@ }, ">" ], - "description": [ - "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten.\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 446 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.checkConflicts.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1734,17 +1958,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 444 - } + "lineNumber": 447 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.checkConflicts.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1754,24 +1981,25 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 445 - } + "lineNumber": 448 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 443 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.delete", "type": "Function", + "tags": [], "label": "delete", + "description": [ + "\nDeletes a SavedObject\n" + ], "signature": [ "(type: string, id: string, options?: ", { @@ -1783,43 +2011,53 @@ }, ") => Promise<{}>" ], - "description": [ - "\nDeletes a SavedObject\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 460 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.delete.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 457 - } + "lineNumber": 460 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.delete.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 457 - } + "lineNumber": 460 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.delete.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1829,26 +2067,27 @@ "text": "SavedObjectsDeleteOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 457 - } + "lineNumber": 460 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 457 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.find", "type": "Function", + "tags": [], "label": "find", + "description": [ + "\nFind all SavedObjects matching the search query\n" + ], "signature": [ - "(options: ", + "(options: ", { "pluginId": "core", "scope": "server", @@ -1864,17 +2103,21 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - ">" - ], - "description": [ - "\nFind all SavedObjects matching the search query\n" + ">" ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 469 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.find.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1884,24 +2127,25 @@ "text": "SavedObjectsFindOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 466 - } + "lineNumber": 470 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 466 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkGet", "type": "Function", + "tags": [], "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" + ], "signature": [ "(objects?: ", { @@ -1929,15 +2173,21 @@ }, ">" ], - "description": [ - "\nReturns an array of objects by id\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 486 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkGet.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [ + "- an array of ids, or an array of objects containing id, type and optionally fields" + ], "signature": [ { "pluginId": "core", @@ -1948,19 +2198,20 @@ }, "[]" ], - "description": [ - "- an array of ids, or an array of objects containing id, type and optionally fields" - ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 482 - } + "lineNumber": 487 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkGet.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1970,24 +2221,25 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 483 - } + "lineNumber": 488 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 481 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.get", "type": "Function", + "tags": [], "label": "get", + "description": [ + "\nRetrieves a single object\n" + ], "signature": [ "(type: string, id: string, options?: ", { @@ -2001,47 +2253,57 @@ "SavedObject", ">" ], - "description": [ - "\nRetrieves a single object\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 500 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.get.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The type of SavedObject to retrieve" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 496 - } + "lineNumber": 501 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.get.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The ID of the SavedObject to retrieve" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 497 - } + "lineNumber": 502 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.get.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2051,24 +2313,25 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 498 - } + "lineNumber": 503 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 495 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.resolve", "type": "Function", + "tags": [], "label": "resolve", + "description": [ + "\nResolves a single object, using any legacy URL alias if it exists\n" + ], "signature": [ "(type: string, id: string, options?: ", { @@ -2088,47 +2351,57 @@ }, ">" ], - "description": [ - "\nResolves a single object, using any legacy URL alias if it exists\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 515 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.resolve.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The type of SavedObject to retrieve" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 511 - } + "lineNumber": 516 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.resolve.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The ID of the SavedObject to retrieve" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 512 - } + "lineNumber": 517 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.resolve.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2138,24 +2411,25 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 513 - } + "lineNumber": 518 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 510 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.update", "type": "Function", + "tags": [], "label": "update", + "description": [ + "\nUpdates an SavedObject\n" + ], "signature": [ "(type: string, id: string, attributes: Partial, options?: ", { @@ -2165,7 +2439,7 @@ "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, - ") => Promise<", + ") => Promise<", { "pluginId": "core", "scope": "server", @@ -2175,57 +2449,70 @@ }, ">" ], - "description": [ - "\nUpdates an SavedObject\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 530 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.update.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 526 - } + "lineNumber": 531 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.update.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 527 - } + "lineNumber": 532 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.update.$3", "type": "Object", + "tags": [], "label": "attributes", - "isRequired": true, + "description": [], "signature": [ "Partial" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 528 - } + "lineNumber": 533 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.update.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2233,26 +2520,28 @@ "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" - } + }, + "" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 529 - } + "lineNumber": 534 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 525 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.addToNamespaces", "type": "Function", + "tags": [], "label": "addToNamespaces", + "description": [ + "\nAdds namespaces to a SavedObject\n" + ], "signature": [ "(type: string, id: string, namespaces: string[], options?: ", { @@ -2272,57 +2561,70 @@ }, ">" ], - "description": [ - "\nAdds namespaces to a SavedObject\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 547 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.addToNamespaces.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 543 - } + "lineNumber": 548 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.addToNamespaces.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 544 - } + "lineNumber": 549 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.addToNamespaces.$3", "type": "Array", + "tags": [], "label": "namespaces", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 545 - } + "lineNumber": 550 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.addToNamespaces.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2332,24 +2634,25 @@ "text": "SavedObjectsAddToNamespacesOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 546 - } + "lineNumber": 551 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 542 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.deleteFromNamespaces", "type": "Function", + "tags": [], "label": "deleteFromNamespaces", + "description": [ + "\nRemoves namespaces from a SavedObject\n" + ], "signature": [ "(type: string, id: string, namespaces: string[], options?: ", { @@ -2369,57 +2672,70 @@ }, ">" ], - "description": [ - "\nRemoves namespaces from a SavedObject\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 564 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.deleteFromNamespaces.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 560 - } + "lineNumber": 565 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.deleteFromNamespaces.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 561 - } + "lineNumber": 566 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.deleteFromNamespaces.$3", "type": "Array", + "tags": [], "label": "namespaces", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 562 - } + "lineNumber": 567 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.deleteFromNamespaces.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2429,24 +2745,25 @@ "text": "SavedObjectsDeleteFromNamespacesOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 563 - } + "lineNumber": 568 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 559 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkUpdate", "type": "Function", + "tags": [], "label": "bulkUpdate", + "description": [ + "\nBulk Updates multiple SavedObject at once\n" + ], "signature": [ "(objects: ", { @@ -2474,15 +2791,19 @@ }, ">" ], - "description": [ - "\nBulk Updates multiple SavedObject at once\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 578 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkUpdate.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2493,17 +2814,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 574 - } + "lineNumber": 579 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkUpdate.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2514,24 +2838,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 575 - } + "lineNumber": 580 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 573 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.removeReferencesTo", "type": "Function", + "tags": [], "label": "removeReferencesTo", + "description": [ + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference." + ], "signature": [ "(type: string, id: string, options?: ", { @@ -2551,43 +2876,53 @@ }, ">" ], - "description": [ - "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference." - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 588 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.removeReferencesTo.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 584 - } + "lineNumber": 589 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.removeReferencesTo.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 585 - } + "lineNumber": 590 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.removeReferencesTo.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2598,24 +2933,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 586 - } + "lineNumber": 591 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 583 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.openPointInTimeForType", "type": "Function", + "tags": [], "label": "openPointInTimeForType", + "description": [ + "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to {@link SavedObjectsClient.find} to search\nagainst that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method." + ], "signature": [ "(type: string | string[], options?: ", { @@ -2633,31 +2969,38 @@ "section": "def-server.SavedObjectsOpenPointInTimeResponse", "text": "SavedObjectsOpenPointInTimeResponse" }, - ">" - ], - "description": [ - "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to {@link SavedObjectsClient.find} to search\nagainst that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method." + ">" ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 604 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.openPointInTimeForType.$1", "type": "CompoundType", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string | string[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 600 - } + "lineNumber": 605 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.openPointInTimeForType.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2667,24 +3010,25 @@ "text": "SavedObjectsOpenPointInTimeOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 601 - } + "lineNumber": 606 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 599 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.closePointInTime", "type": "Function", + "tags": [], "label": "closePointInTime", + "description": [ + "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES via the\nElasticsearch client, and is included in the Saved Objects Client as a convenience\nfor consumers who are using {@link SavedObjectsClient.openPointInTimeForType}.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method." + ], "signature": [ "(id: string, options?: ", { @@ -2704,29 +3048,36 @@ }, ">" ], - "description": [ - "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES via the\nElasticsearch client, and is included in the Saved Objects Client as a convenience\nfor consumers who are using {@link SavedObjectsClient.openPointInTimeForType}.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method." - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 619 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.closePointInTime.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 614 - } + "lineNumber": 619 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.closePointInTime.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2737,24 +3088,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 614 - } + "lineNumber": 619 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 614 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.createPointInTimeFinder", "type": "Function", + "tags": [], "label": "createPointInTimeFinder", + "description": [ + "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThe generator wraps calls to {@link SavedObjectsClient.find} and iterates\nover multiple pages of results using `_pit` and `search_after`. This will\nopen a new Point-In-Time (PIT), and continue paging until a set of\nresults is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" + ], "signature": [ "(findOptions: Pick<", { @@ -2764,7 +3116,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ", + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">, dependencies?: ", { "pluginId": "core", "scope": "server", @@ -2781,15 +3133,19 @@ "text": "ISavedObjectsPointInTimeFinder" } ], - "description": [ - "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThe generator wraps calls to {@link SavedObjectsClient.find} and iterates\nover multiple pages of results using `_pit` and `search_after`. This will\nopen a new Point-In-Time (PIT), and continue paging until a set of\nresults is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 668 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.createPointInTimeFinder.$1", "type": "Object", + "tags": [], "label": "findOptions", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -2799,19 +3155,22 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">" + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 664 - } + "lineNumber": 669 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.createPointInTimeFinder.$2", "type": "Object", + "tags": [], "label": "dependencies", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2822,40 +3181,39 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 665 - } + "lineNumber": 670 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 663 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 401 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectsErrorHelpers", "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 72 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError", "type": "Function", + "tags": [], "label": "isSavedObjectsClientError", + "description": [], "signature": [ "typeof ", { @@ -2867,34 +3225,39 @@ }, ".isSavedObjectsClientError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 73 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError.$1", "type": "Any", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 73 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 73 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError", "type": "Function", + "tags": [], "label": "decorateBadRequestError", + "description": [], "signature": [ "typeof ", { @@ -2906,48 +3269,56 @@ }, ".decorateBadRequestError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 77 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 77 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError.$2", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 77 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 77 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createBadRequestError", "type": "Function", + "tags": [], "label": "createBadRequestError", + "description": [], "signature": [ "typeof ", { @@ -2959,34 +3330,39 @@ }, ".createBadRequestError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 81 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createBadRequestError.$1", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 81 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError", "type": "Function", + "tags": [], "label": "createUnsupportedTypeError", + "description": [], "signature": [ "typeof ", { @@ -2998,34 +3374,39 @@ }, ".createUnsupportedTypeError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 85 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 85 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 85 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isBadRequestError", "type": "Function", + "tags": [], "label": "isBadRequestError", + "description": [], "signature": [ "typeof ", { @@ -3037,35 +3418,40 @@ }, ".isBadRequestError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 92 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isBadRequestError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 92 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 92 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError", "type": "Function", + "tags": [], "label": "createInvalidVersionError", + "description": [], "signature": [ "typeof ", { @@ -3077,34 +3463,39 @@ }, ".createInvalidVersionError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 96 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError.$1", "type": "string", + "tags": [], "label": "versionInput", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 96 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 96 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError", "type": "Function", + "tags": [], "label": "isInvalidVersionError", + "description": [], "signature": [ "typeof ", { @@ -3116,35 +3507,40 @@ }, ".isInvalidVersionError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 104 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 104 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError", "type": "Function", + "tags": [], "label": "decorateNotAuthorizedError", + "description": [], "signature": [ "typeof ", { @@ -3156,48 +3552,56 @@ }, ".decorateNotAuthorizedError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 108 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 108 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError.$2", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 108 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 108 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError", "type": "Function", + "tags": [], "label": "isNotAuthorizedError", + "description": [], "signature": [ "typeof ", { @@ -3209,35 +3613,40 @@ }, ".isNotAuthorizedError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 112 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 112 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 112 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError", "type": "Function", + "tags": [], "label": "decorateForbiddenError", + "description": [], "signature": [ "typeof ", { @@ -3249,48 +3658,56 @@ }, ".decorateForbiddenError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 116 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 116 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError.$2", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 116 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 116 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isForbiddenError", "type": "Function", + "tags": [], "label": "isForbiddenError", + "description": [], "signature": [ "typeof ", { @@ -3302,35 +3719,40 @@ }, ".isForbiddenError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 120 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isForbiddenError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 120 - } + }, + "deprecated": false, + "isRequired": true } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 120 - } + ], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError", "type": "Function", + "tags": [], "label": "decorateRequestEntityTooLargeError", + "description": [], "signature": [ "typeof ", { @@ -3342,48 +3764,56 @@ }, ".decorateRequestEntityTooLargeError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 124 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 124 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError.$2", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 124 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 124 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError", "type": "Function", + "tags": [], "label": "isRequestEntityTooLargeError", + "description": [], "signature": [ "typeof ", { @@ -3395,35 +3825,40 @@ }, ".isRequestEntityTooLargeError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 127 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 127 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 127 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError", "type": "Function", + "tags": [], "label": "createGenericNotFoundError", + "description": [], "signature": [ "typeof ", { @@ -3435,48 +3870,56 @@ }, ".createGenericNotFoundError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 131 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError.$1", "type": "CompoundType", + "tags": [], "label": "type", - "isRequired": false, + "description": [], "signature": [ "string | null" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 131 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError.$2", "type": "CompoundType", + "tags": [], "label": "id", - "isRequired": false, + "description": [], "signature": [ "string | null" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 131 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 131 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError", "type": "Function", + "tags": [], "label": "createIndexAliasNotFoundError", + "description": [], "signature": [ "typeof ", { @@ -3488,34 +3931,39 @@ }, ".createIndexAliasNotFoundError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 138 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError.$1", "type": "string", + "tags": [], "label": "alias", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 138 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError", "type": "Function", + "tags": [], "label": "decorateIndexAliasNotFoundError", + "description": [], "signature": [ "typeof ", { @@ -3527,48 +3975,56 @@ }, ".decorateIndexAliasNotFoundError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 142 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 142 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError.$2", "type": "string", + "tags": [], "label": "alias", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 142 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 142 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isNotFoundError", "type": "Function", + "tags": [], "label": "isNotFoundError", + "description": [], "signature": [ "typeof ", { @@ -3580,35 +4036,40 @@ }, ".isNotFoundError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 151 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isNotFoundError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 151 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 151 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError", "type": "Function", + "tags": [], "label": "decorateConflictError", + "description": [], "signature": [ "typeof ", { @@ -3620,48 +4081,56 @@ }, ".decorateConflictError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 155 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 155 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError.$2", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 155 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 155 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createConflictError", "type": "Function", + "tags": [], "label": "createConflictError", + "description": [], "signature": [ "typeof ", { @@ -3673,62 +4142,73 @@ }, ".createConflictError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 159 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 159 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 159 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$3", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 159 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 159 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isConflictError", "type": "Function", + "tags": [], "label": "isConflictError", + "description": [], "signature": [ "typeof ", { @@ -3740,35 +4220,40 @@ }, ".isConflictError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 166 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isConflictError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 166 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 166 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError", "type": "Function", + "tags": [], "label": "decorateTooManyRequestsError", + "description": [], "signature": [ "typeof ", { @@ -3780,48 +4265,56 @@ }, ".decorateTooManyRequestsError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 170 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 170 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError.$2", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 170 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 170 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError", "type": "Function", + "tags": [], "label": "createTooManyRequestsError", + "description": [], "signature": [ "typeof ", { @@ -3833,48 +4326,56 @@ }, ".createTooManyRequestsError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 174 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 174 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 174 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 174 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError", "type": "Function", + "tags": [], "label": "isTooManyRequestsError", + "description": [], "signature": [ "typeof ", { @@ -3886,35 +4387,40 @@ }, ".isTooManyRequestsError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 178 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 178 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 178 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError", "type": "Function", + "tags": [], "label": "decorateEsCannotExecuteScriptError", + "description": [], "signature": [ "typeof ", { @@ -3926,48 +4432,56 @@ }, ".decorateEsCannotExecuteScriptError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 182 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 182 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError.$2", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 182 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 182 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError", "type": "Function", + "tags": [], "label": "isEsCannotExecuteScriptError", + "description": [], "signature": [ "typeof ", { @@ -3979,35 +4493,40 @@ }, ".isEsCannotExecuteScriptError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 186 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 186 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 186 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError", "type": "Function", + "tags": [], "label": "decorateEsUnavailableError", + "description": [], "signature": [ "typeof ", { @@ -4019,48 +4538,56 @@ }, ".decorateEsUnavailableError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 190 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 190 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError.$2", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 190 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 190 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError", "type": "Function", + "tags": [], "label": "isEsUnavailableError", + "description": [], "signature": [ "typeof ", { @@ -4072,35 +4599,40 @@ }, ".isEsUnavailableError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 194 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 194 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 194 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError", "type": "Function", + "tags": [], "label": "decorateGeneralError", + "description": [], "signature": [ "typeof ", { @@ -4112,48 +4644,56 @@ }, ".decorateGeneralError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 198 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 198 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError.$2", "type": "string", + "tags": [], "label": "reason", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 198 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 198 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isGeneralError", "type": "Function", + "tags": [], "label": "isGeneralError", + "description": [], "signature": [ "typeof ", { @@ -4165,57 +4705,56 @@ }, ".isGeneralError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 202 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsErrorHelpers.isGeneralError.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "Error | ", "DecoratedError" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 202 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 202 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "lineNumber": 72 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectsExporter", "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.savedObjectsClient", "type": "Object", + "tags": [], "label": "#savedObjectsClient", "description": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 37 - }, "signature": [ "Pick<", { @@ -4226,18 +4765,20 @@ "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.exportTransforms", "type": "Object", + "tags": [], "label": "#exportTransforms", "description": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 38 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 38 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.exportSizeLimit", "type": "number", + "tags": [], "label": "#exportSizeLimit", "description": [], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "lineNumber": 39 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.log", "type": "Object", + "tags": [], "label": "#log", "description": [], + "signature": [ + "Logger" + ], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "lineNumber": 40 }, - "signature": [ - "Logger" - ] + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger", "type": "Object", - "label": "{\n savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }", "tags": [], + "label": "{\n savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }", "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.savedObjectsClient", "type": "Object", + "tags": [], "label": "savedObjectsClient", "description": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 48 - }, "signature": [ "Pick<", { @@ -4311,18 +4871,20 @@ "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 48 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.typeRegistry", "type": "Object", + "tags": [], "label": "typeRegistry", "description": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 49 - }, "signature": [ "Pick<", { @@ -4333,51 +4895,58 @@ "text": "SavedObjectTypeRegistry" }, ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 49 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.exportSizeLimit", "type": "number", + "tags": [], "label": "exportSizeLimit", "description": [], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "lineNumber": 50 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.logger", "type": "Object", + "tags": [], "label": "logger", "description": [], + "signature": [ + "Logger" + ], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "lineNumber": 51 }, - "signature": [ - "Logger" - ] + "deprecated": false } - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 47 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 42 - } + "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: ", { @@ -4391,15 +4960,19 @@ "Readable", ">" ], - "description": [ - "\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n" - ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.exportByTypes.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -4409,26 +4982,27 @@ "text": "SavedObjectsExportByTypeOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "lineNumber": 74 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "throws" - ], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 74 - } + "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: ", { @@ -4442,15 +5016,19 @@ "Readable", ">" ], - "description": [ - "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" - ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 92 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.exportByObjects.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -4460,35 +5038,24 @@ "text": "SavedObjectsExportByObjectOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "lineNumber": 92 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "throws" - ], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 92 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 36 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectsExportError", "description": [], "signature": [ @@ -4501,70 +5068,89 @@ }, " extends Error" ], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.Unnamed.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/export/errors.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.Unnamed.$2", "type": "string", + "tags": [], "label": "message", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/export/errors.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.Unnamed.$3", "type": "Object", + "tags": [], "label": "attributes", - "isRequired": false, + "description": [], "signature": [ "Record | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/export/errors.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 15 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.exportSizeExceeded", "type": "Function", + "tags": [], "label": "exportSizeExceeded", + "description": [], "signature": [ "typeof ", { @@ -4576,34 +5162,39 @@ }, ".exportSizeExceeded" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.exportSizeExceeded.$1", "type": "number", + "tags": [], "label": "limit", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/core/server/saved_objects/export/errors.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 27 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.objectFetchError", "type": "Function", + "tags": [], "label": "objectFetchError", + "description": [], "signature": [ "typeof ", { @@ -4615,35 +5206,42 @@ }, ".objectFetchError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.objectFetchError.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [], "signature": [ "SavedObject", "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/export/errors.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 36 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.objectTransformError", "type": "Function", + "tags": [], "label": "objectTransformError", + "description": [ + "\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error" + ], "signature": [ "typeof ", { @@ -4655,51 +5253,59 @@ }, ".objectTransformError" ], - "description": [ - "\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error" - ], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.objectTransformError.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [], "signature": [ "SavedObject", "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/export/errors.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.objectTransformError.$2", "type": "Object", + "tags": [], "label": "cause", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/core/server/saved_objects/export/errors.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.invalidTransformError", "type": "Function", + "tags": [], "label": "invalidTransformError", + "description": [ + "\nError returned when a {@link SavedObjectsExportTransform | export tranform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id." + ], "signature": [ "typeof ", { @@ -4711,58 +5317,55 @@ }, ".invalidTransformError" ], - "description": [ - "\nError returned when a {@link SavedObjectsExportTransform | export tranform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id." - ], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportError.invalidTransformError.$1", "type": "Array", + "tags": [], "label": "objectKeys", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/export/errors.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 60 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectsImporter", "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.savedObjectsClient", "type": "Object", + "tags": [], "label": "#savedObjectsClient", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 30 - }, "signature": [ "Pick<", { @@ -4773,18 +5376,20 @@ "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 30 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.typeRegistry", "type": "Object", + "tags": [], "label": "#typeRegistry", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 31 - }, "signature": [ "Pick<", { @@ -4795,29 +5400,33 @@ "text": "SavedObjectTypeRegistry" }, ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 31 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.importSizeLimit", "type": "number", + "tags": [], "label": "#importSizeLimit", "description": [], "source": { "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.importHooks", "type": "Object", + "tags": [], "label": "#importHooks", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 33 - }, "signature": [ "Record[]>" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 33 + }, + "deprecated": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit", "type": "Object", - "label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", "tags": [], + "label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.savedObjectsClient", "type": "Object", + "tags": [], "label": "savedObjectsClient", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 40 - }, "signature": [ "Pick<", { @@ -4866,18 +5490,20 @@ "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 40 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.typeRegistry", "type": "Object", + "tags": [], "label": "typeRegistry", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 41 - }, "signature": [ "Pick<", { @@ -4888,37 +5514,42 @@ "text": "SavedObjectTypeRegistry" }, ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 41 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.importSizeLimit", "type": "number", + "tags": [], "label": "importSizeLimit", "description": [], "source": { "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "lineNumber": 42 - } + }, + "deprecated": false } - ], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 39 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 35 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.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": [ "({ readStream, createNewCopies, namespace, overwrite, }: ", { @@ -4938,15 +5569,19 @@ }, ">" ], - "description": [ - "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" - ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.import.$1", "type": "Object", + "tags": [], "label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -4956,26 +5591,27 @@ "text": "SavedObjectsImportOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "lineNumber": 64 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "throws" - ], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 64 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.resolveImportErrors", "type": "Function", + "tags": [ + "throws" + ], "label": "resolveImportErrors", + "description": [ + "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed informations.\n" + ], "signature": [ "({ readStream, createNewCopies, namespace, retries, }: ", { @@ -4995,15 +5631,19 @@ }, ">" ], - "description": [ - "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed informations.\n" - ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 88 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsImporter.resolveImportErrors.$1", "type": "Object", + "tags": [], "label": "{\n readStream,\n createNewCopies,\n namespace,\n retries,\n }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5013,35 +5653,24 @@ "text": "SavedObjectsResolveImportErrorsOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "lineNumber": 88 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "throws" - ], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 88 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectsImportError", "description": [], "signature": [ @@ -5054,11 +5683,19 @@ }, " extends Error" ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError.importSizeExceeded", "type": "Function", + "tags": [], "label": "importSizeExceeded", + "description": [], "signature": [ "typeof ", { @@ -5070,34 +5707,39 @@ }, ".importSizeExceeded" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError.importSizeExceeded.$1", "type": "number", + "tags": [], "label": "limit", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/core/server/saved_objects/import/errors.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 27 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects", "type": "Function", + "tags": [], "label": "nonUniqueImportObjects", + "description": [], "signature": [ "typeof ", { @@ -5109,34 +5751,39 @@ }, ".nonUniqueImportObjects" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects.$1", "type": "Array", + "tags": [], "label": "nonUniqueEntries", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/import/errors.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 34 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects", "type": "Function", + "tags": [], "label": "nonUniqueRetryObjects", + "description": [], "signature": [ "typeof ", { @@ -5148,34 +5795,39 @@ }, ".nonUniqueRetryObjects" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects.$1", "type": "Array", + "tags": [], "label": "nonUniqueRetryObjects", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/import/errors.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 41 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations", "type": "Function", + "tags": [], "label": "nonUniqueRetryDestinations", + "description": [], "signature": [ "typeof ", { @@ -5187,34 +5839,39 @@ }, ".nonUniqueRetryDestinations" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations.$1", "type": "Array", + "tags": [], "label": "nonUniqueRetryDestinations", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/import/errors.ts", "lineNumber": 48 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 48 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError.referencesFetchError", "type": "Function", + "tags": [], "label": "referencesFetchError", + "description": [], "signature": [ "typeof ", { @@ -5226,51 +5883,64 @@ }, ".referencesFetchError" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportError.referencesFetchError.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [], "signature": [ "SavedObject", "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/import/errors.ts", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 55 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectsRepository", "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 159 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.create", "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property" + ], "label": "create", + "description": [ + "\nPersists an object\n" + ], "signature": [ "(type: string, attributes: T, options?: ", { @@ -5284,43 +5954,53 @@ "SavedObject", ">" ], - "description": [ - "\nPersists an object\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 257 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.create.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 257 - } + "lineNumber": 258 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.create.$2", "type": "Uncategorized", + "tags": [], "label": "attributes", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 258 - } + "lineNumber": 259 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.create.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5330,28 +6010,30 @@ "text": "SavedObjectsCreateOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 259 - } + "lineNumber": 260 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], "returnComment": [ "- { id, type, version, attributes }" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 256 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkCreate", "type": "Function", + "tags": [ + "property", + "property" + ], "label": "bulkCreate", + "description": [ + "\nCreates multiple documents at once\n" + ], "signature": [ "(objects: ", { @@ -5379,15 +6061,21 @@ }, ">" ], - "description": [ - "\nCreates multiple documents at once\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 350 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkCreate.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [ + "- [{ type, id, attributes, references, migrationVersion }]" + ], "signature": [ { "pluginId": "core", @@ -5398,19 +6086,20 @@ }, "[]" ], - "description": [ - "- [{ type, id, attributes, references, migrationVersion }]" - ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 350 - } + "lineNumber": 351 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkCreate.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5420,28 +6109,27 @@ "text": "SavedObjectsCreateOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 351 - } + "lineNumber": 352 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], "returnComment": [ "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 349 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.checkConflicts", "type": "Function", + "tags": [], "label": "checkConflicts", + "description": [ + "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten." + ], "signature": [ "(objects?: ", { @@ -5469,15 +6157,19 @@ }, ">" ], - "description": [ - "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten." - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 541 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.checkConflicts.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5488,17 +6180,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 541 - } + "lineNumber": 542 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.checkConflicts.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5508,24 +6203,27 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 542 - } + "lineNumber": 543 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 540 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.delete", "type": "Function", + "tags": [ + "property" + ], "label": "delete", + "description": [ + "\nDeletes an object\n" + ], "signature": [ "(type: string, id: string, options?: ", { @@ -5537,43 +6235,53 @@ }, ") => Promise<{}>" ], - "description": [ - "\nDeletes an object\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 628 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.delete.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 627 - } + "lineNumber": 628 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.delete.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 627 - } + "lineNumber": 628 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.delete.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5583,26 +6291,25 @@ "text": "SavedObjectsDeleteOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 627 - } + "lineNumber": 628 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 627 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.deleteByNamespace", "type": "Function", + "tags": [], "label": "deleteByNamespace", + "description": [ + "\nDeletes all objects from the provided namespace.\n" + ], "signature": [ "(namespace: string, options?: ", { @@ -5614,29 +6321,36 @@ }, ") => Promise" ], - "description": [ - "\nDeletes all objects from the provided namespace.\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 690 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.deleteByNamespace.$1", "type": "string", + "tags": [], "label": "namespace", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 690 - } + "lineNumber": 691 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.deleteByNamespace.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5646,28 +6360,42 @@ "text": "SavedObjectsDeleteByNamespaceOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 691 - } + "lineNumber": 692 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 689 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.find", "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], "label": "find", + "description": [], "signature": [ - "(options: ", + "(options: ", { "pluginId": "core", "scope": "server", @@ -5683,15 +6411,21 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - ">" + ">" ], - "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 752 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.find.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5701,28 +6435,29 @@ "text": "SavedObjectsFindOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 751 - } + "lineNumber": 753 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], "returnComment": [ "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 751 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkGet", "type": "Function", + "tags": [ + "property" + ], "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" + ], "signature": [ "(objects?: ", { @@ -5750,15 +6485,21 @@ }, ">" ], - "description": [ - "\nReturns an array of objects by id\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 919 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkGet.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [ + "- an array of objects containing id, type and optionally fields" + ], "signature": [ { "pluginId": "core", @@ -5769,19 +6510,20 @@ }, "[]" ], - "description": [ - "- an array of objects containing id, type and optionally fields" - ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 906 - } + "lineNumber": 920 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkGet.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5791,28 +6533,29 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 907 - } + "lineNumber": 921 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], "returnComment": [ "- { saved_objects: [{ id, type, version, attributes }] }" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 905 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.get", "type": "Function", + "tags": [ + "property" + ], "label": "get", + "description": [ + "\nGets a single object\n" + ], "signature": [ "(type: string, id: string, options?: ", { @@ -5826,43 +6569,53 @@ "SavedObject", ">" ], - "description": [ - "\nGets a single object\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1006 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.get.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 993 - } + "lineNumber": 1007 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.get.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 994 - } + "lineNumber": 1008 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.get.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5872,28 +6625,29 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 995 - } + "lineNumber": 1009 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], "returnComment": [ "- { id, type, version, attributes }" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 992 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.resolve", "type": "Function", + "tags": [ + "property" + ], "label": "resolve", + "description": [ + "\nResolves a single object, using any legacy URL alias if it exists\n" + ], "signature": [ "(type: string, id: string, options?: ", { @@ -5913,43 +6667,53 @@ }, ">" ], - "description": [ - "\nResolves a single object, using any legacy URL alias if it exists\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1048 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.resolve.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1035 - } + "lineNumber": 1049 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.resolve.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1036 - } + "lineNumber": 1050 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.resolve.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5959,28 +6723,31 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1037 - } + "lineNumber": 1051 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], "returnComment": [ "- { saved_object, outcome }" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1034 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.update", "type": "Function", + "tags": [ + "property", + "property", + "property" + ], "label": "update", + "description": [ + "\nUpdates an object\n" + ], "signature": [ "(type: string, id: string, attributes: Partial, options?: ", { @@ -5990,7 +6757,7 @@ "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, - ") => Promise<", + ") => Promise<", { "pluginId": "core", "scope": "server", @@ -6000,57 +6767,70 @@ }, ">" ], - "description": [ - "\nUpdates an object\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1173 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.update.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1160 - } + "lineNumber": 1174 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.update.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1161 - } + "lineNumber": 1175 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.update.$3", "type": "Object", + "tags": [], "label": "attributes", - "isRequired": true, + "description": [], "signature": [ "Partial" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1162 - } + "lineNumber": 1176 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.update.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6058,28 +6838,28 @@ "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" - } + }, + "" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1163 - } + "lineNumber": 1177 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1159 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.addToNamespaces", "type": "Function", + "tags": [], "label": "addToNamespaces", + "description": [ + "\nAdds one or more namespaces to a given multi-namespace saved object. This method and\n[`deleteFromNamespaces`]{@link SavedObjectsRepository.deleteFromNamespaces} are the only ways to change which Spaces a multi-namespace\nsaved object is shared to." + ], "signature": [ "(type: string, id: string, namespaces: string[], options?: ", { @@ -6099,57 +6879,70 @@ }, ">" ], - "description": [ - "\nAdds one or more namespaces to a given multi-namespace saved object. This method and\n[`deleteFromNamespaces`]{@link SavedObjectsRepository.deleteFromNamespaces} are the only ways to change which Spaces a multi-namespace\nsaved object is shared to." - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1270 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.addToNamespaces.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1232 - } + "lineNumber": 1271 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.addToNamespaces.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1233 - } + "lineNumber": 1272 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.addToNamespaces.$3", "type": "Array", + "tags": [], "label": "namespaces", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1234 - } + "lineNumber": 1273 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.addToNamespaces.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6159,24 +6952,25 @@ "text": "SavedObjectsAddToNamespacesOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1235 - } + "lineNumber": 1274 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1231 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.deleteFromNamespaces", "type": "Function", + "tags": [], "label": "deleteFromNamespaces", + "description": [ + "\nRemoves one or more namespaces from a given multi-namespace saved object. If no namespaces remain, the saved object is deleted\nentirely. This method and [`addToNamespaces`]{@link SavedObjectsRepository.addToNamespaces} are the only ways to change which Spaces a\nmulti-namespace saved object is shared to." + ], "signature": [ "(type: string, id: string, namespaces: string[], options?: ", { @@ -6196,57 +6990,70 @@ }, ">" ], - "description": [ - "\nRemoves one or more namespaces from a given multi-namespace saved object. If no namespaces remain, the saved object is deleted\nentirely. This method and [`addToNamespaces`]{@link SavedObjectsRepository.addToNamespaces} are the only ways to change which Spaces a\nmulti-namespace saved object is shared to." - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1333 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.deleteFromNamespaces.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1295 - } + "lineNumber": 1334 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.deleteFromNamespaces.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1296 - } + "lineNumber": 1335 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.deleteFromNamespaces.$3", "type": "Array", + "tags": [], "label": "namespaces", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1297 - } + "lineNumber": 1336 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.deleteFromNamespaces.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6256,24 +7063,28 @@ "text": "SavedObjectsDeleteFromNamespacesOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1298 - } + "lineNumber": 1337 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1294 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkUpdate", "type": "Function", + "tags": [ + "property", + "property" + ], "label": "bulkUpdate", + "description": [ + "\nUpdates multiple objects in bulk\n" + ], "signature": [ "(objects: ", { @@ -6301,15 +7112,21 @@ }, ">" ], - "description": [ - "\nUpdates multiple objects in bulk\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1439 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkUpdate.$1", "type": "Array", + "tags": [], "label": "objects", - "isRequired": true, + "description": [ + "- [{ type, id, attributes, options: { version, namespace } references }]" + ], "signature": [ { "pluginId": "core", @@ -6320,19 +7137,20 @@ }, "[]" ], - "description": [ - "- [{ type, id, attributes, options: { version, namespace } references }]" - ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1401 - } + "lineNumber": 1440 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkUpdate.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6342,28 +7160,27 @@ "text": "SavedObjectsBulkUpdateOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1402 - } + "lineNumber": 1441 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], "returnComment": [ "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1400 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.removeReferencesTo", "type": "Function", + "tags": [], "label": "removeReferencesTo", + "description": [ + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" + ], "signature": [ "(type: string, id: string, options?: ", { @@ -6383,43 +7200,53 @@ }, ">" ], - "description": [ - "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1658 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.removeReferencesTo.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1620 - } + "lineNumber": 1659 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.removeReferencesTo.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1621 - } + "lineNumber": 1660 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.removeReferencesTo.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6429,24 +7256,25 @@ "text": "SavedObjectsRemoveReferencesToOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1622 - } + "lineNumber": 1661 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1619 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.incrementCounter", "type": "Function", + "tags": [], "label": "incrementCounter", + "description": [ + "\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n" + ], "signature": [ "(type: string, id: string, counterFields: (string | ", { @@ -6468,47 +7296,59 @@ "SavedObject", ">" ], - "description": [ - "\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1769 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.incrementCounter.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The type of saved object whose fields should be incremented" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1731 - } + "lineNumber": 1770 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.incrementCounter.$2", "type": "string", + "tags": [], "label": "id", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The id of the document whose fields should be incremented" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1732 - } + "lineNumber": 1771 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.incrementCounter.$3", "type": "Array", + "tags": [], "label": "counterFields", - "isRequired": true, + "description": [ + "- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField}" + ], "signature": [ "(string | ", { @@ -6520,19 +7360,22 @@ }, ")[]" ], - "description": [ - "- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField}" - ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1733 - } + "lineNumber": 1772 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.incrementCounter.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [ + "- {@link SavedObjectsIncrementCounterOptions}" + ], "signature": [ { "pluginId": "core", @@ -6543,28 +7386,30 @@ }, "" ], - "description": [ - "- {@link SavedObjectsIncrementCounterOptions}" - ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1734 - } + "lineNumber": 1773 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "The saved object after the specified fields were incremented" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1730 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.openPointInTimeForType", "type": "Function", + "tags": [ + "property", + "property" + ], "label": "openPointInTimeForType", + "description": [ + "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" + ], "signature": [ "(type: string | string[], { keepAlive, preference }?: ", { @@ -6584,29 +7429,36 @@ }, ">" ], - "description": [ - "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1929 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$1", "type": "CompoundType", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string | string[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1891 - } + "lineNumber": 1930 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$2", "type": "Object", + "tags": [], "label": "{ keepAlive = '5m', preference }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6616,28 +7468,27 @@ "text": "SavedObjectsOpenPointInTimeOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1892 - } + "lineNumber": 1931 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], "returnComment": [ "- { id: string }" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1890 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.closePointInTime", "type": "Function", + "tags": [], "label": "closePointInTime", + "description": [ + "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" + ], "signature": [ "(id: string, options?: ", { @@ -6657,29 +7508,38 @@ }, ">" ], - "description": [ - "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 2002 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.closePointInTime.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1967 - } + "lineNumber": 2003 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.closePointInTime.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [ + "- {@link SavedObjectsClosePointInTimeOptions}" + ], "signature": [ { "pluginId": "core", @@ -6690,28 +7550,27 @@ }, " | undefined" ], - "description": [ - "- {@link SavedObjectsClosePointInTimeOptions}" - ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1968 - } + "lineNumber": 2004 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [ "- {@link SavedObjectsClosePointInTimeResponse}" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1966 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.createPointInTimeFinder", "type": "Function", + "tags": [], "label": "createPointInTimeFinder", + "description": [ + "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThis generator wraps calls to {@link SavedObjectsRepository.find} and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a\nset of results is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" + ], "signature": [ "(findOptions: Pick<", { @@ -6721,7 +7580,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ", + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">, dependencies?: ", { "pluginId": "core", "scope": "server", @@ -6738,15 +7597,19 @@ "text": "ISavedObjectsPointInTimeFinder" } ], - "description": [ - "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThis generator wraps calls to {@link SavedObjectsRepository.find} and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a\nset of results is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 2058 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$1", "type": "Object", + "tags": [], "label": "findOptions", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -6756,19 +7619,22 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">" + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 2023 - } + "lineNumber": 2059 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$2", "type": "Object", + "tags": [], "label": "dependencies", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -6779,42 +7645,43 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 2024 - } + "lineNumber": 2060 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 2022 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 158 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectsSerializer", "description": [ "\nA serializer that can be used to manually convert {@link SavedObjectsRawDoc | raw} or\n{@link SavedObjectSanitizedDoc | sanitized} documents to the other kind.\n" ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.isRawSavedObject", "type": "Function", + "tags": [], "label": "isRawSavedObject", + "description": [ + "\nDetermines whether or not the raw document can be converted to a saved object.\n" + ], "signature": [ "(doc: ", { @@ -6834,15 +7701,21 @@ }, ") => boolean" ], - "description": [ - "\nDetermines whether or not the raw document can be converted to a saved object.\n" - ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$1", "type": "Object", + "tags": [], "label": "doc", - "isRequired": true, + "description": [ + "- The raw ES document to be tested" + ], "signature": [ { "pluginId": "core", @@ -6852,19 +7725,22 @@ "text": "SavedObjectsRawDoc" } ], - "description": [ - "- The raw ES document to be tested" - ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [ + "- Options for parsing the raw document." + ], "signature": [ { "pluginId": "core", @@ -6874,26 +7750,25 @@ "text": "SavedObjectsRawDocParseOptions" } ], - "description": [ - "- Options for parsing the raw document." - ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 41 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.rawToSavedObject", "type": "Function", + "tags": [], "label": "rawToSavedObject", + "description": [ + "\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n" + ], "signature": [ "(doc: ", { @@ -6921,15 +7796,21 @@ }, "" ], - "description": [ - "\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n" - ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 79 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$1", "type": "Object", + "tags": [], "label": "doc", - "isRequired": true, + "description": [ + "- The raw ES document to be converted to saved object format." + ], "signature": [ { "pluginId": "core", @@ -6939,19 +7820,22 @@ "text": "SavedObjectsRawDoc" } ], - "description": [ - "- The raw ES document to be converted to saved object format." - ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 59 - } + "lineNumber": 80 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [ + "- Options for parsing the raw document." + ], "signature": [ { "pluginId": "core", @@ -6961,26 +7845,25 @@ "text": "SavedObjectsRawDocParseOptions" } ], - "description": [ - "- Options for parsing the raw document." - ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 60 - } + "lineNumber": 81 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 58 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.savedObjectToRaw", "type": "Function", + "tags": [], "label": "savedObjectToRaw", + "description": [ + "\nConverts a document from the saved object client format to the format that is stored in elasticsearch.\n" + ], "signature": [ "(savedObj: ", { @@ -6999,15 +7882,21 @@ "text": "SavedObjectsRawDoc" } ], - "description": [ - "\nConverts a document from the saved object client format to the format that is stored in elasticsearch.\n" - ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 125 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.savedObjectToRaw.$1", "type": "CompoundType", + "tags": [], "label": "savedObj", - "isRequired": true, + "description": [ + "- The saved object to be converted to raw ES format." + ], "signature": [ { "pluginId": "core", @@ -7018,265 +7907,275 @@ }, "" ], - "description": [ - "- The saved object to be converted to raw ES format." - ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 102 - } + "lineNumber": 125 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 102 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.generateRawId", "type": "Function", + "tags": [], "label": "generateRawId", - "signature": [ - "(namespace: string | undefined, type: string, id: string) => string" - ], "description": [ "\nGiven a saved object type and id, generates the compound id that is stored in the raw document.\n" ], + "signature": [ + "(namespace: string | undefined, type: string, id: string) => string" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 166 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.generateRawId.$1", "type": "string", + "tags": [], "label": "namespace", - "isRequired": false, - "signature": [ - "string | undefined" - ], "description": [ "- The namespace of the saved object" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 143 - } + "lineNumber": 166 + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.generateRawId.$2", "type": "string", + "tags": [], "label": "type", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The saved object type" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 143 - } + "lineNumber": 166 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.generateRawId.$3", "type": "string", + "tags": [], "label": "id", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The id of the saved object" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 143 - } + "lineNumber": 166 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 143 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId", "type": "Function", + "tags": [], "label": "generateRawLegacyUrlAliasId", - "signature": [ - "(namespace: string, type: string, id: string) => string" - ], "description": [ "\nGiven a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias.\n" ], + "signature": [ + "(namespace: string, type: string, id: string) => string" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 179 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$1", "type": "string", + "tags": [], "label": "namespace", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The namespace of the saved object" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 156 - } + "lineNumber": 179 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$2", "type": "string", - "label": "type", - "isRequired": true, - "signature": [ - "string" - ], + "tags": [], + "label": "type", "description": [ "- The saved object type" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 156 - } + "lineNumber": 179 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$3", "type": "string", + "tags": [], "label": "id", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The id of the saved object" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 156 - } + "lineNumber": 179 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 156 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsUtils", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectsUtils", "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsUtils.namespaceIdToString", "type": "Function", + "tags": [], + "label": "namespaceIdToString", + "description": [ + "\nConverts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with\nthe exception of the `undefined` namespace ID (which has a namespace string of `'default'`).\n" + ], + "signature": [ + "(namespace?: string | undefined) => string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsUtils.namespaceIdToString.$1", "type": "string", + "tags": [], "label": "namespace", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/utils.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(namespace?: string | undefined) => string" - ], - "description": [ - "\nConverts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with\nthe exception of the `undefined` namespace ID (which has a namespace string of `'default'`).\n" - ], - "label": "namespaceIdToString", - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 29 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsUtils.namespaceStringToId", "type": "Function", + "tags": [], + "label": "namespaceStringToId", + "description": [ + "\nConverts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with\nthe exception of the `'default'` namespace string (which has a namespace ID of `undefined`).\n" + ], + "signature": [ + "(namespace: string) => string | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsUtils.namespaceStringToId.$1", "type": "string", + "tags": [], "label": "namespace", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/utils.ts", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(namespace: string) => string | undefined" - ], - "description": [ - "\nConverts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with\nthe exception of the `'default'` namespace string (which has a namespace ID of `undefined`).\n" - ], - "label": "namespaceStringToId", - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 43 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsUtils.createEmptyFindResponse", "type": "Function", - "children": [ - { - "id": "def-server.SavedObjectsUtils.createEmptyFindResponse.$1", - "type": "Object", - "label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - } - ], - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 54 - } - } + "tags": [], + "label": "createEmptyFindResponse", + "description": [ + "\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers." ], "signature": [ - "({ page, perPage, }: ", + "({ page, perPage, }: ", { "pluginId": "core", "scope": "server", @@ -7292,23 +8191,49 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - "" - ], - "description": [ - "\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers." + "" ], - "label": "createEmptyFindResponse", "source": { "path": "src/core/server/saved_objects/service/lib/utils.ts", "lineNumber": 54 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUtils.createEmptyFindResponse.$1", + "type": "Object", + "tags": [], + "label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 54 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsUtils.generateId", "type": "Function", + "tags": [], "label": "generateId", + "description": [ + "\nGenerates a random ID for a saved objects." + ], "signature": [ "typeof ", { @@ -7320,21 +8245,25 @@ }, ".generateId" ], - "description": [ - "\nGenerates a random ID for a saved objects." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/utils.ts", "lineNumber": 67 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsUtils.isRandomId", "type": "Function", + "tags": [ + "todo" + ], "label": "isRandomId", + "description": [ + "\nValidates that a saved object ID has been randomly generated.\n" + ], "signature": [ "typeof ", { @@ -7346,58 +8275,61 @@ }, ".isRandomId" ], - "description": [ - "\nValidates that a saved object ID has been randomly generated.\n" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 77 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsUtils.isRandomId.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": false, - "signature": [ - "string | undefined" - ], "description": [ "The ID of a saved object." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/lib/utils.ts", "lineNumber": 77 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "todo" - ], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 77 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SavedObjectTypeRegistry", "description": [ "\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n" ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.registerType", "type": "Function", + "tags": [], "label": "registerType", + "description": [ + "\nRegister a {@link SavedObjectsType | type} inside the registry.\nA type can only be registered once. subsequent calls with the same type name will throw an error." + ], "signature": [ "(type: ", { @@ -7409,15 +8341,19 @@ }, ") => void" ], - "description": [ - "\nRegister a {@link SavedObjectsType | type} inside the registry.\nA type can only be registered once. subsequent calls with the same type name will throw an error." - ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.registerType.$1", "type": "Object", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -7427,24 +8363,25 @@ "text": "SavedObjectsType" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 31 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.getType", "type": "Function", + "tags": [], "label": "getType", + "description": [ + "\nReturn the {@link SavedObjectsType | type} definition for given type name." + ], "signature": [ "(type: string) => ", { @@ -7456,36 +8393,41 @@ }, " | undefined" ], - "description": [ - "\nReturn the {@link SavedObjectsType | type} definition for given type name." - ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.getType.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 42 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.getVisibleTypes", "type": "Function", + "tags": [], "label": "getVisibleTypes", + "description": [ + "\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration." + ], "signature": [ "() => ", { @@ -7497,21 +8439,23 @@ }, "[]" ], - "description": [ - "\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 51 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.getAllTypes", "type": "Function", + "tags": [], "label": "getAllTypes", + "description": [ + "\nReturn all {@link SavedObjectsType | types} currently registered, including the hidden ones.\n\nTo only get the visible types (which is the most common use case), use `getVisibleTypes` instead." + ], "signature": [ "() => ", { @@ -7523,21 +8467,23 @@ }, "[]" ], - "description": [ - "\nReturn all {@link SavedObjectsType | types} currently registered, including the hidden ones.\n\nTo only get the visible types (which is the most common use case), use `getVisibleTypes` instead." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes", "type": "Function", + "tags": [], "label": "getImportableAndExportableTypes", + "description": [ + "\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable." + ], "signature": [ "() => ", { @@ -7548,280 +8494,309 @@ "text": "SavedObjectsType" }, "[]" - ], - "description": [ - "\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable." - ], - "children": [], - "tags": [], - "returnComment": [], + ], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 67 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic", "type": "Function", + "tags": [], "label": "isNamespaceAgnostic", - "signature": [ - "(type: string) => boolean" - ], "description": [ "\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered" ], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 75 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 75 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 75 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace", "type": "Function", + "tags": [], "label": "isSingleNamespace", - "signature": [ - "(type: string) => boolean" - ], "description": [ "\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered" ], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 83 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace", "type": "Function", + "tags": [], "label": "isMultiNamespace", - "signature": [ - "(type: string) => boolean" - ], "description": [ "\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered" ], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 92 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 92 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 92 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isShareable", "type": "Function", + "tags": [], "label": "isShareable", - "signature": [ - "(type: string) => boolean" - ], "description": [ "\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered" ], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 101 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isShareable.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 101 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 101 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isHidden", "type": "Function", + "tags": [], "label": "isHidden", - "signature": [ - "(type: string) => boolean" - ], "description": [ "\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered." ], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 109 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isHidden.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 109 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 109 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.getIndex", "type": "Function", + "tags": [], "label": "getIndex", - "signature": [ - "(type: string) => string | undefined" - ], "description": [ "\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered." ], + "signature": [ + "(type: string) => string | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 117 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.getIndex.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 117 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 117 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", "type": "Function", + "tags": [], "label": "isImportableAndExportable", - "signature": [ - "(type: string) => boolean" - ], "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" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 125 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 125 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 125 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 24 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "core", "id": "def-server.ISavedObjectsPointInTimeFinder", "type": "Interface", + "tags": [], "label": "ISavedObjectsPointInTimeFinder", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.ISavedObjectsPointInTimeFinder.find", "type": "Function", + "tags": [], "label": "find", "description": [ "\nAn async generator which wraps calls to `savedObjectsClient.find` and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a set\nof results is received that's smaller than the designated `perPage` size." ], - "source": { - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "lineNumber": 49 - }, "signature": [ "() => AsyncGenerator<", { @@ -7831,53 +8806,57 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - ", any, unknown>" - ] + ", any, unknown>" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "lineNumber": 49 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.ISavedObjectsPointInTimeFinder.close", "type": "Function", + "tags": [], "label": "close", "description": [ "\nCloses the Point-In-Time associated with this finder instance.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason." ], + "signature": [ + "() => Promise" + ], "source": { "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", "lineNumber": 60 }, - "signature": [ - "() => Promise" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "lineNumber": 42 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectExportBaseOptions", "type": "Interface", + "tags": [], "label": "SavedObjectExportBaseOptions", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectExportBaseOptions.request", "type": "Object", + "tags": [], "label": "request", "description": [ "The http request initiating the export." ], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 15 - }, "signature": [ { "pluginId": "core", @@ -7887,86 +8866,94 @@ "text": "KibanaRequest" }, "" - ] + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 15 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectExportBaseOptions.includeReferencesDeep", "type": "CompoundType", + "tags": [], "label": "includeReferencesDeep", "description": [ "flag to also include all related saved objects in the export stream." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/export/types.ts", "lineNumber": 17 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectExportBaseOptions.excludeExportDetails", "type": "CompoundType", + "tags": [], "label": "excludeExportDetails", "description": [ "flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/export/types.ts", "lineNumber": 19 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectExportBaseOptions.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [ "optional namespace to override the namespace used by the savedObjectsClient." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/export/types.ts", "lineNumber": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectMigrationContext", "type": "Interface", + "tags": [], "label": "SavedObjectMigrationContext", "description": [ "\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectMigrationContext.log", "type": "Object", + "tags": [], "label": "log", "description": [ "\nlogger instance to be used by the migration handler" ], - "source": { - "path": "src/core/server/saved_objects/migrations/types.ts", - "lineNumber": 59 - }, "signature": [ { "pluginId": "core", @@ -7975,12 +8962,18 @@ "section": "def-server.SavedObjectsMigrationLogger", "text": "SavedObjectsMigrationLogger" } - ] + ], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 59 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectMigrationContext.migrationVersion", "type": "string", + "tags": [], "label": "migrationVersion", "description": [ "\nThe migration version that this migration function is defined for" @@ -7988,67 +8981,73 @@ "source": { "path": "src/core/server/saved_objects/migrations/types.ts", "lineNumber": 63 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion", "type": "string", + "tags": [], "label": "convertToMultiNamespaceTypeVersion", "description": [ "\nThe version in which this object type is being converted to a multi-namespace type" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/migrations/types.ts", "lineNumber": 67 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/migrations/types.ts", - "lineNumber": 55 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectMigrationMap", "type": "Interface", + "tags": [], "label": "SavedObjectMigrationMap", "description": [ "\nA map of {@link SavedObjectMigrationFn | migration functions} to be used for a given type.\nThe map's keys must be valid semver versions, and they cannot exceed the current Kibana version.\n\nFor a given document, only migrations with a higher version number than that of the document will be applied.\nMigrations are executed in order, starting from the lowest version and ending with the highest one.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 87 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectMigrationMap.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/saved_objects/migrations/types.ts", "lineNumber": 88 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/migrations/types.ts", - "lineNumber": 87 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsAddToNamespacesOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsAddToNamespacesOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8066,124 +9065,132 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 225 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsAddToNamespacesOptions.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" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 224 + "lineNumber": 227 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsAddToNamespacesOptions.refresh", "type": "CompoundType", + "tags": [], "label": "refresh", "description": [ "The Elasticsearch Refresh setting for this operation" ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 226 + "lineNumber": 229 }, - "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 222 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsAddToNamespacesResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsAddToNamespacesResponse", "description": [ "\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 236 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsAddToNamespacesResponse.namespaces", "type": "Array", + "tags": [], "label": "namespaces", "description": [ "The namespaces the object exists in after this operation is complete." ], + "signature": [ + "string[]" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 235 + "lineNumber": 238 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 233 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBaseOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsBaseOptions", "description": [ "\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 162 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBaseOptions.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [ "Specify the namespace for this operation" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 142 + "lineNumber": 164 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 140 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkCreateObject", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8194,213 +9201,237 @@ }, "" ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 71 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 72 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject.attributes", "type": "Uncategorized", + "tags": [], "label": "attributes", "description": [], + "signature": [ + "T" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 73 }, - "signature": [ - "T" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject.version", "type": "string", + "tags": [], "label": "version", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 74 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject.references", "type": "Array", + "tags": [], "label": "references", "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 75 }, - "signature": [ - "SavedObjectReference", - "[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject.migrationVersion", "type": "Object", + "tags": [], "label": "migrationVersion", "description": [ "{@inheritDoc SavedObjectsMigrationVersion}" ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 77 }, - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject.coreMigrationVersion", "type": "string", + "tags": [], "label": "coreMigrationVersion", "description": [ "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 87 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject.originId", "type": "string", + "tags": [], "label": "originId", "description": [ "Optional ID of the original saved object, if this object's `id` was regenerated" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 89 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces", "type": "Array", + "tags": [], "label": "initialNamespaces", "description": [ "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\nNote: this can only be used for multi-namespace object types." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 96 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 70 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkGetObject", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkGetObject", "description": [ "\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 301 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkGetObject.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 299 - } + "lineNumber": 302 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkGetObject.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 300 - } + "lineNumber": 303 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkGetObject.fields", "type": "Array", + "tags": [], "label": "fields", "description": [ "SavedObject fields to include in the response" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 302 + "lineNumber": 305 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 298 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkResponse", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8411,39 +9442,41 @@ }, "" ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 124 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkResponse.saved_objects", "type": "Array", + "tags": [], "label": "saved_objects", "description": [], + "signature": [ + "SavedObject", + "[]" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 125 }, - "signature": [ - "SavedObject", - "[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 124 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkResponse", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8454,39 +9487,41 @@ }, "" ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 312 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkResponse.saved_objects", "type": "Array", + "tags": [], "label": "saved_objects", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 310 - }, "signature": [ "SavedObject", "[]" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 313 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 309 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateObject", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkUpdateObject", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8503,19 +9538,19 @@ "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, - ", \"version\" | \"references\">" - ], - "description": [ - "\n" - ], - "tags": [ - "public" + ", \"version\" | \"references\">" ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 103 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateObject.id", "type": "string", + "tags": [], "label": "id", "description": [ "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" @@ -8523,12 +9558,14 @@ "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 106 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateObject.type", "type": "string", + "tags": [], "label": "type", "description": [ " The type of this Saved Object. Each plugin can define it's own custom Saved Object types." @@ -8536,51 +9573,57 @@ "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 108 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateObject.attributes", "type": "Object", + "tags": [], "label": "attributes", "description": [ "{@inheritdoc SavedObjectAttributes}" ], + "signature": [ + "Partial" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 110 }, - "signature": [ - "Partial" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateObject.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [ "\nOptional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsBulkUpdateOptions}.\n\nNote: the default namespace's string representation is `'default'`, and its ID representation is `undefined`." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 117 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 103 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkUpdateOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8598,40 +9641,42 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 281 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateOptions.refresh", "type": "CompoundType", + "tags": [], "label": "refresh", "description": [ "The Elasticsearch Refresh setting for this operation" ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 280 + "lineNumber": 283 }, - "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 278 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkUpdateResponse", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8642,23 +9687,19 @@ }, "" ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 320 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects", "type": "Array", + "tags": [], "label": "saved_objects", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 318 - }, "signature": [ { "pluginId": "core", @@ -8668,156 +9709,168 @@ "text": "SavedObjectsUpdateResponse" }, "[]" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 321 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 317 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsCheckConflictsObject", "type": "Interface", + "tags": [], "label": "SavedObjectsCheckConflictsObject", "description": [ "\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 189 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCheckConflictsObject.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 189 - } + "lineNumber": 190 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCheckConflictsObject.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 190 - } + "lineNumber": 191 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 188 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsCheckConflictsResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsCheckConflictsResponse", "description": [ "\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 198 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCheckConflictsResponse.errors", "type": "Array", + "tags": [], "label": "errors", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 198 - }, "signature": [ "{ id: string; type: string; error: ", "SavedObjectError", "; }[]" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 199 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 197 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClientProviderOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsClientProviderOptions", "description": [ "\nOptions to control the creation of the Saved Objects Client." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers", "type": "Array", + "tags": [], "label": "excludedWrappers", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", "lineNumber": 58 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes", "type": "Array", + "tags": [], "label": "includedHiddenTypes", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", "lineNumber": 59 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClientWrapperOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsClientWrapperOptions", "description": [ "\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsClientWrapperOptions.client", "type": "Object", + "tags": [], "label": "client", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 20 - }, "signature": [ "Pick<", { @@ -8828,18 +9881,20 @@ "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 20 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsClientWrapperOptions.typeRegistry", "type": "Object", + "tags": [], "label": "typeRegistry", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 21 - }, "signature": [ "Pick<", { @@ -8850,18 +9905,20 @@ "text": "SavedObjectTypeRegistry" }, ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsClientWrapperOptions.request", "type": "Object", + "tags": [], "label": "request", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 22 - }, "signature": [ { "pluginId": "core", @@ -8871,136 +9928,150 @@ "text": "KibanaRequest" }, "" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 22 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClosePointInTimeResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsClosePointInTimeResponse", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 388 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsClosePointInTimeResponse.succeeded", "type": "boolean", + "tags": [], "label": "succeeded", "description": [ "\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed." ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 390 - } + "lineNumber": 393 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed", "type": "number", + "tags": [], "label": "num_freed", "description": [ "\nThe number of search contexts that have been successfully closed." ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 394 - } + "lineNumber": 397 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 385 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsComplexFieldMapping", "type": "Interface", + "tags": [], "label": "SavedObjectsComplexFieldMapping", "description": [ "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 141 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsComplexFieldMapping.dynamic", "type": "CompoundType", + "tags": [], "label": "dynamic", "description": [ "\nThe dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings.\n\nNote: To limit the number of mapping fields Saved Object types should\n*never* use `dynamic: true`." ], + "signature": [ + "false | \"strict\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 150 }, - "signature": [ - "false | \"strict\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsComplexFieldMapping.enabled", "type": "CompoundType", + "tags": [], "label": "enabled", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 151 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsComplexFieldMapping.doc_values", "type": "CompoundType", + "tags": [], "label": "doc_values", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 152 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsComplexFieldMapping.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 153 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsComplexFieldMapping.properties", "type": "Object", + "tags": [], "label": "properties", "description": [], - "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 154 - }, "signature": [ { "pluginId": "core", @@ -9009,104 +10080,120 @@ "section": "def-server.SavedObjectsMappingProperties", "text": "SavedObjectsMappingProperties" } - ] + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 154 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 141 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsCoreFieldMapping", "type": "Interface", + "tags": [], "label": "SavedObjectsCoreFieldMapping", "description": [ "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 123 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCoreFieldMapping.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 124 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCoreFieldMapping.null_value", "type": "CompoundType", + "tags": [], "label": "null_value", "description": [], + "signature": [ + "string | number | boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 125 }, - "signature": [ - "string | number | boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCoreFieldMapping.index", "type": "CompoundType", + "tags": [], "label": "index", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 126 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCoreFieldMapping.doc_values", "type": "CompoundType", + "tags": [], "label": "doc_values", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 127 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCoreFieldMapping.fields", "type": "Object", + "tags": [], "label": "fields", "description": [], + "signature": [ + "{ [subfield: string]: { type: string; ignore_above?: number | undefined; }; } | undefined" + ], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 128 }, - "signature": [ - "{ [subfield: string]: { type: string; ignore_above?: number | undefined; }; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 123 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsCreateOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsCreateOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -9124,183 +10211,197 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCreateOptions.id", "type": "string", + "tags": [], "label": "id", "description": [ "(not recommended) Specify an id for the document" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 32 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCreateOptions.overwrite", "type": "CompoundType", + "tags": [], "label": "overwrite", "description": [ "Overwrite existing documents (defaults to false)" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 34 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCreateOptions.version", "type": "string", + "tags": [], "label": "version", "description": [ "\nAn opaque version number which changes on each successful write operation.\nCan be used in conjunction with `overwrite` for implementing optimistic concurrency control." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 39 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCreateOptions.migrationVersion", "type": "Object", + "tags": [], "label": "migrationVersion", "description": [ "{@inheritDoc SavedObjectsMigrationVersion}" ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 41 }, - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion", "type": "string", + "tags": [], "label": "coreMigrationVersion", "description": [ "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 51 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCreateOptions.references", "type": "Array", + "tags": [], "label": "references", "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 52 }, - "signature": [ - "SavedObjectReference", - "[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCreateOptions.refresh", "type": "CompoundType", + "tags": [], "label": "refresh", "description": [ "The Elasticsearch Refresh setting for this operation" ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 54 }, - "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCreateOptions.originId", "type": "string", + "tags": [], "label": "originId", "description": [ "Optional ID of the original saved object, if this object's `id` was regenerated" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 56 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCreateOptions.initialNamespaces", "type": "Array", + "tags": [], "label": "initialNamespaces", "description": [ "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\nNote: this can only be used for multi-namespace object types." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 63 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", "type": "Interface", + "tags": [], "label": "SavedObjectsCreatePointInTimeFinderDependencies", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies.client", "type": "Object", + "tags": [], "label": "client", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "lineNumber": 30 - }, "signature": [ "Pick, \"find\" | \"openPointInTimeForType\" | \"closePointInTime\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "lineNumber": 30 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteByNamespaceOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsDeleteByNamespaceOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -9341,40 +10448,42 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 132 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh", "type": "CompoundType", + "tags": [], "label": "refresh", "description": [ "The Elasticsearch supports only boolean flag for this operation" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 133 + "lineNumber": 134 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 131 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteFromNamespacesOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsDeleteFromNamespacesOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -9392,74 +10501,78 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 245 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteFromNamespacesOptions.refresh", "type": "CompoundType", + "tags": [], "label": "refresh", "description": [ "The Elasticsearch Refresh setting for this operation" ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 244 + "lineNumber": 247 }, - "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 242 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteFromNamespacesResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsDeleteFromNamespacesResponse", "description": [ "\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 254 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteFromNamespacesResponse.namespaces", "type": "Array", + "tags": [], "label": "namespaces", "description": [ "The namespaces the object exists in after this operation is complete. An empty array indicates the object was deleted." ], + "signature": [ + "string[]" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 253 + "lineNumber": 256 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 251 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsDeleteOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -9477,56 +10590,60 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 290 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteOptions.refresh", "type": "CompoundType", + "tags": [], "label": "refresh", "description": [ "The Elasticsearch Refresh setting for this operation" ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 289 + "lineNumber": 292 }, - "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteOptions.force", "type": "CompoundType", + "tags": [], "label": "force", "description": [ "Force deletion of an object that exists in multiple namespaces" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 291 + "lineNumber": 294 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 287 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportByObjectOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsExportByObjectOptions", + "description": [ + "\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n" + ], "signature": [ { "pluginId": "core", @@ -9544,40 +10661,42 @@ "text": "SavedObjectExportBaseOptions" } ], - "description": [ - "\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExportByObjectOptions.objects", "type": "Array", + "tags": [], "label": "objects", "description": [ "optional array of objects to export." ], + "signature": [ + "{ id: string; type: string; }[]" + ], "source": { "path": "src/core/server/saved_objects/export/types.ts", "lineNumber": 45 }, - "signature": [ - "{ id: string; type: string; }[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 43 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportByTypeOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsExportByTypeOptions", + "description": [ + "\nOptions for the {@link SavedObjectsExporter.exportByTypes | export by type API}\n" + ], "signature": [ { "pluginId": "core", @@ -9595,41 +10714,39 @@ "text": "SavedObjectExportBaseOptions" } ], - "description": [ - "\nOptions for the {@link SavedObjectsExporter.exportByTypes | export by type API}\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExportByTypeOptions.types", "type": "Array", + "tags": [], "label": "types", "description": [ "array of saved object types." ], + "signature": [ + "string[]" + ], "source": { "path": "src/core/server/saved_objects/export/types.ts", "lineNumber": 31 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExportByTypeOptions.hasReference", "type": "Array", + "tags": [], "label": "hasReference", "description": [ "optional array of references to search object for." ], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 33 - }, "signature": [ { "pluginId": "core", @@ -9639,46 +10756,54 @@ "text": "SavedObjectsFindOptionsReference" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExportByTypeOptions.search", "type": "string", + "tags": [], "label": "search", "description": [ "optional query string to filter exported objects." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/export/types.ts", "lineNumber": 35 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportResultDetails", "type": "Interface", + "tags": [], "label": "SavedObjectsExportResultDetails", "description": [ "\nStructure of the export result details entry" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExportResultDetails.exportedCount", "type": "number", + "tags": [], "label": "exportedCount", "description": [ "number of successfully exported objects" @@ -9686,12 +10811,14 @@ "source": { "path": "src/core/server/saved_objects/export/types.ts", "lineNumber": 59 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExportResultDetails.missingRefCount", "type": "number", + "tags": [], "label": "missingRefCount", "description": [ "number of missing references" @@ -9699,54 +10826,54 @@ "source": { "path": "src/core/server/saved_objects/export/types.ts", "lineNumber": 61 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExportResultDetails.missingReferences", "type": "Array", + "tags": [], "label": "missingReferences", "description": [ "missing references details" ], + "signature": [ + "{ id: string; type: string; }[]" + ], "source": { "path": "src/core/server/saved_objects/export/types.ts", "lineNumber": 63 }, - "signature": [ - "{ id: string; type: string; }[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportTransformContext", "type": "Interface", + "tags": [], "label": "SavedObjectsExportTransformContext", "description": [ "\nContext passed down to a {@link SavedObjectsExportTransform | export transform function}\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 76 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsExportTransformContext.request", "type": "Object", + "tags": [], "label": "request", "description": [ "\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}" ], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 81 - }, "signature": [ { "pluginId": "core", @@ -9756,188 +10883,210 @@ "text": "KibanaRequest" }, "" - ] + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 81 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 76 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsFindOptions", "description": [ "\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 78 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 79 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.page", "type": "number", + "tags": [], "label": "page", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 80 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 81 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.sortField", "type": "string", + "tags": [], "label": "sortField", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 82 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.sortOrder", "type": "CompoundType", + "tags": [], "label": "sortOrder", "description": [], + "signature": [ + "\"asc\" | \"desc\" | \"_doc\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 83 }, - "signature": [ - "\"asc\" | \"desc\" | \"_doc\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.fields", "type": "Array", + "tags": [], "label": "fields", "description": [ "\nAn array of fields to include in the results" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 89 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.search", "type": "string", + "tags": [], "label": "search", "description": [ "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 91 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.searchFields", "type": "Array", + "tags": [], "label": "searchFields", "description": [ "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 93 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.searchAfter", "type": "Array", + "tags": [], "label": "searchAfter", "description": [ "\nUse the sort values from the previous page to retrieve the next page of results." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 97 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.rootSearchFields", "type": "Array", + "tags": [], "label": "rootSearchFields", "description": [ "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 102 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.hasReference", "type": "CompoundType", + "tags": [], "label": "hasReference", "description": [ "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 108 - }, "signature": [ { "pluginId": "core", @@ -9955,112 +11104,148 @@ "text": "SavedObjectsFindOptionsReference" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 108 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.hasReferenceOperator", "type": "CompoundType", + "tags": [], "label": "hasReferenceOperator", "description": [ "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" ], + "signature": [ + "\"AND\" | \"OR\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 112 }, - "signature": [ - "\"AND\" | \"OR\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.defaultSearchOperator", "type": "CompoundType", + "tags": [], "label": "defaultSearchOperator", "description": [ "\nThe search operator to use with the provided filter. Defaults to `OR`" ], + "signature": [ + "\"AND\" | \"OR\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 117 }, - "signature": [ - "\"AND\" | \"OR\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.filter", "type": "Any", + "tags": [], "label": "filter", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 118 }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.aggs", + "type": "Object", + "tags": [ + "alpha" + ], + "label": "aggs", + "description": [ + "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + ], "signature": [ - "any" - ] + "Record | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 140 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.namespaces", "type": "Array", + "tags": [], "label": "namespaces", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 119 + "lineNumber": 141 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap", "type": "Object", + "tags": [], "label": "typeToNamespacesMap", "description": [ "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." ], + "signature": [ + "Map | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 127 + "lineNumber": 149 }, - "signature": [ - "Map | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.preference", "type": "string", + "tags": [], "label": "preference", "description": [ "An optional ES preference value to be used for the query" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 129 + "lineNumber": 151 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptions.pit", "type": "Object", + "tags": [], "label": "pit", "description": [ "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 133 - }, "signature": [ { "pluginId": "core", @@ -10070,57 +11255,67 @@ "text": "SavedObjectsPitParams" }, " | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 155 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 78 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptionsReference", "type": "Interface", + "tags": [], "label": "SavedObjectsFindOptionsReference", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptionsReference.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 62 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindOptionsReference.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 63 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 61 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsFindResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsFindResponse", + "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", @@ -10129,25 +11324,37 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - "" - ], - "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" - ], - "tags": [ - "public" + "" ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 176 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.aggregations", + "type": "Uncategorized", "tags": [], - "id": "def-server.SavedObjectsFindResponse.saved_objects", - "type": "Array", - "label": "saved_objects", + "label": "aggregations", "description": [], + "signature": [ + "A | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 177 }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.saved_objects", + "type": "Array", + "tags": [], + "label": "saved_objects", + "description": [], "signature": [ { "pluginId": "core", @@ -10157,66 +11364,80 @@ "text": "SavedObjectsFindResult" }, "[]" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 178 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindResponse.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 178 - } + "lineNumber": 179 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindResponse.per_page", "type": "number", + "tags": [], "label": "per_page", "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 179 - } + "lineNumber": 180 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindResponse.page", "type": "number", + "tags": [], "label": "page", "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 180 - } + "lineNumber": 181 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindResponse.pit_id", "type": "string", + "tags": [], "label": "pit_id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 181 + "lineNumber": 182 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 176 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsFindResult", "type": "Interface", + "tags": [], "label": "SavedObjectsFindResult", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -10229,17 +11450,17 @@ "SavedObject", "" ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 132 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindResult.score", "type": "number", + "tags": [], "label": "score", "description": [ "\nThe Elasticsearch `_score` of this result." @@ -10247,60 +11468,66 @@ "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 136 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindResult.sort", "type": "Array", + "tags": [], "label": "sort", "description": [ "\nThe Elasticsearch `sort` value of this result.\n" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 165 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 132 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportActionRequiredWarning", "type": "Interface", + "tags": [], "label": "SavedObjectsImportActionRequiredWarning", "description": [ "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 200 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportActionRequiredWarning.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"action_required\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 201 }, - "signature": [ - "\"action_required\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportActionRequiredWarning.message", "type": "string", + "tags": [], "label": "message", "description": [ "The translated message to display to the user." @@ -10308,12 +11535,14 @@ "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 203 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath", "type": "string", + "tags": [], "label": "actionPath", "description": [ "The path (without the basePath) that the user should be redirect to address this warning." @@ -10321,212 +11550,231 @@ "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 205 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportActionRequiredWarning.buttonLabel", "type": "string", + "tags": [], "label": "buttonLabel", "description": [ "An optional label to use for the link button. If unspecified, a default label will be used." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 207 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 200 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportAmbiguousConflictError", "type": "Interface", + "tags": [], "label": "SavedObjectsImportAmbiguousConflictError", "description": [ "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportAmbiguousConflictError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"ambiguous_conflict\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 54 }, - "signature": [ - "\"ambiguous_conflict\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations", "type": "Array", + "tags": [], "label": "destinations", "description": [], + "signature": [ + "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 55 }, - "signature": [ - "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportConflictError", "type": "Interface", + "tags": [], "label": "SavedObjectsImportConflictError", "description": [ "\nRepresents a failure to import due to a conflict." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportConflictError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"conflict\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 45 }, - "signature": [ - "\"conflict\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportConflictError.destinationId", "type": "string", + "tags": [], "label": "destinationId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 46 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportFailure", "type": "Interface", + "tags": [], "label": "SavedObjectsImportFailure", "description": [ "\nRepresents a failure to import." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 89 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportFailure.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 90 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportFailure.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 91 - } + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportFailure.title", + "type": "string", "tags": [ "deprecated" ], - "id": "def-server.SavedObjectsImportFailure.title", - "type": "string", "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 95 }, - "signature": [ - "string | undefined" - ] + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportFailure.meta", "type": "Object", + "tags": [], "label": "meta", "description": [], + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 96 }, - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportFailure.overwrite", "type": "CompoundType", + "tags": [], "label": "overwrite", "description": [ "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 100 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportFailure.error", "type": "CompoundType", + "tags": [], "label": "error", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 101 - }, "signature": [ { "pluginId": "core", @@ -10567,38 +11815,40 @@ "section": "def-server.SavedObjectsImportUnknownError", "text": "SavedObjectsImportUnknownError" } - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 101 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 89 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportHookResult", "type": "Interface", + "tags": [], "label": "SavedObjectsImportHookResult", "description": [ "\nResult from a {@link SavedObjectsImportHook | import hook}\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 227 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportHookResult.warnings", "type": "Array", + "tags": [], "label": "warnings", "description": [ "\nAn optional list of warnings to display in the UI when the import succeeds." ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 231 - }, "signature": [ { "pluginId": "core", @@ -10608,92 +11858,104 @@ "text": "SavedObjectsImportWarning" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 231 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 227 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportMissingReferencesError", "type": "Interface", + "tags": [], "label": "SavedObjectsImportMissingReferencesError", "description": [ "\nRepresents a failure to import due to missing references." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportMissingReferencesError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"missing_references\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 81 }, - "signature": [ - "\"missing_references\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportMissingReferencesError.references", "type": "Array", + "tags": [], "label": "references", "description": [], + "signature": [ + "{ type: string; id: string; }[]" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 82 }, - "signature": [ - "{ type: string; id: string; }[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 80 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsImportOptions", "description": [ "\nOptions to control the import operation." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 153 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportOptions.readStream", "type": "Object", + "tags": [], "label": "readStream", "description": [ "The stream of {@link SavedObject | saved objects} to import" ], + "signature": [ + "Readable" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 155 }, - "signature": [ - "Readable" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportOptions.overwrite", "type": "boolean", + "tags": [], "label": "overwrite", "description": [ "If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option." @@ -10701,28 +11963,32 @@ "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 157 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportOptions.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [ "if specified, will import in given namespace, else will import as global object" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 159 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportOptions.createNewCopies", "type": "boolean", + "tags": [], "label": "createNewCopies", "description": [ "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." @@ -10730,58 +11996,60 @@ "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 161 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 153 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsImportResponse", "description": [ "\nThe response describing the result of an import." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 141 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportResponse.success", "type": "boolean", + "tags": [], "label": "success", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 142 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportResponse.successCount", "type": "number", + "tags": [], "label": "successCount", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 143 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportResponse.successResults", "type": "Array", + "tags": [], "label": "successResults", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 144 - }, "signature": [ { "pluginId": "core", @@ -10791,18 +12059,20 @@ "text": "SavedObjectsImportSuccess" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 144 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportResponse.warnings", "type": "Array", + "tags": [], "label": "warnings", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 145 - }, "signature": [ { "pluginId": "core", @@ -10812,18 +12082,20 @@ "text": "SavedObjectsImportWarning" }, "[]" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 145 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportResponse.errors", "type": "Array", + "tags": [], "label": "errors", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 146 - }, "signature": [ { "pluginId": "core", @@ -10833,157 +12105,179 @@ "text": "SavedObjectsImportFailure" }, "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 146 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 141 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportRetry", "type": "Interface", + "tags": [], "label": "SavedObjectsImportRetry", "description": [ "\nDescribes a retry operation for importing a saved object." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportRetry.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportRetry.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportRetry.overwrite", "type": "boolean", + "tags": [], "label": "overwrite", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportRetry.destinationId", "type": "string", + "tags": [], "label": "destinationId", "description": [ "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 23 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportRetry.replaceReferences", "type": "Array", + "tags": [], "label": "replaceReferences", "description": [], + "signature": [ + "{ type: string; from: string; to: string; }[]" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 24 }, - "signature": [ - "{ type: string; from: string; to: string; }[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportRetry.createNewCopy", "type": "CompoundType", + "tags": [], "label": "createNewCopy", "description": [ "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 33 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences", "type": "CompoundType", + "tags": [], "label": "ignoreMissingReferences", "description": [ "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 37 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportSimpleWarning", "type": "Interface", + "tags": [], "label": "SavedObjectsImportSimpleWarning", "description": [ "\nA simple informative warning that will be displayed to the user.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 186 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportSimpleWarning.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"simple\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 187 }, - "signature": [ - "\"simple\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportSimpleWarning.message", "type": "string", + "tags": [], "label": "message", "description": [ "The translated message to display to the user" @@ -10991,252 +12285,292 @@ "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 189 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 186 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportSuccess", "type": "Interface", + "tags": [], "label": "SavedObjectsImportSuccess", "description": [ "\nRepresents a successful import." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 113 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportSuccess.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 114 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportSuccess.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 115 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportSuccess.destinationId", "type": "string", + "tags": [], "label": "destinationId", "description": [ "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 119 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportSuccess.createNewCopy", + "type": "CompoundType", "tags": [ "deprecated" ], - "id": "def-server.SavedObjectsImportSuccess.createNewCopy", - "type": "CompoundType", "label": "createNewCopy", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 126 }, - "signature": [ - "boolean | undefined" + "deprecated": true, + "references": [ + { + "plugin": "savedObjectsManagement", + "link": { + "path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts", + "lineNumber": 223 + } + }, + { + "plugin": "spaces", + "link": { + "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx", + "lineNumber": 142 + } + } ] }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportSuccess.meta", "type": "Object", + "tags": [], "label": "meta", "description": [], + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 127 }, - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportSuccess.overwrite", "type": "CompoundType", + "tags": [], "label": "overwrite", "description": [ "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 134 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 113 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportUnknownError", "type": "Interface", + "tags": [], "label": "SavedObjectsImportUnknownError", "description": [ "\nRepresents a failure to import due to an unknown reason." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportUnknownError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"unknown\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 71 }, - "signature": [ - "\"unknown\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportUnknownError.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 72 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportUnknownError.statusCode", "type": "number", + "tags": [], "label": "statusCode", "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 73 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 70 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportUnsupportedTypeError", "type": "Interface", + "tags": [], "label": "SavedObjectsImportUnsupportedTypeError", "description": [ "\nRepresents a failure to import due to having an unsupported saved object type." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsImportUnsupportedTypeError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"unsupported_type\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 63 }, - "signature": [ - "\"unsupported_type\"" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 62 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsIncrementCounterField", "type": "Interface", + "tags": [], "label": "SavedObjectsIncrementCounterField", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 149 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsIncrementCounterField.fieldName", "type": "string", + "tags": [], "label": "fieldName", "description": [ "The field name to increment the counter by." ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 150 - } + "lineNumber": 151 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsIncrementCounterField.incrementBy", "type": "number", + "tags": [], "label": "incrementBy", "description": [ "The number to increment the field by (defaults to 1)." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 152 + "lineNumber": 153 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 148 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsIncrementCounterOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsIncrementCounterOptions", + "description": [], "signature": [ { "pluginId": "core", @@ -11254,209 +12588,261 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 108 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsIncrementCounterOptions.initialize", "type": "CompoundType", + "tags": [], "label": "initialize", "description": [ "\n(default=false) If true, sets all the counter fields to 0 if they don't\nalready exist. Existing fields will be left as-is and won't be incremented." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 113 + "lineNumber": 114 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", "type": "Object", + "tags": [], "label": "migrationVersion", "description": [ "{@link SavedObjectsMigrationVersion}" ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 115 - }, "signature": [ "SavedObjectsMigrationVersion", " | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 116 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsIncrementCounterOptions.refresh", "type": "CompoundType", + "tags": [], "label": "refresh", "description": [ "\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}" ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 120 + "lineNumber": 121 }, - "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsIncrementCounterOptions.upsertAttributes", "type": "Uncategorized", + "tags": [], "label": "upsertAttributes", "description": [ "\nAttributes to use when upserting the document if it doesn't exist." ], + "signature": [ + "Attributes | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 124 + "lineNumber": 125 }, - "signature": [ - "Attributes | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 107 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsMappingProperties", "type": "Interface", + "tags": [], "label": "SavedObjectsMappingProperties", "description": [ "\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 87 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.SavedObjectsMappingProperties.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 88 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 87 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsMigrationLogger", "type": "Interface", + "tags": [], "label": "SavedObjectsMigrationLogger", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsMigrationLogger.debug", "type": "Function", + "tags": [], "label": "debug", "description": [], + "signature": [ + "(msg: string) => void" + ], "source": { "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "lineNumber": 20 }, - "signature": [ - "(msg: string) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsMigrationLogger.info", "type": "Function", + "tags": [], "label": "info", "description": [], + "signature": [ + "(msg: string) => void" + ], "source": { "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "lineNumber": 21 }, - "signature": [ - "(msg: string) => void" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMigrationLogger.warning", + "type": "Function", "tags": [ "deprecated" ], - "id": "def-server.SavedObjectsMigrationLogger.warning", - "type": "Function", "label": "warning", "description": [], + "signature": [ + "(msg: string) => void" + ], "source": { "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "lineNumber": 25 }, - "signature": [ - "(msg: string) => void" + "deprecated": true, + "references": [ + { + "plugin": "dashboard", + "link": { + "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts", + "lineNumber": 29 + } + }, + { + "plugin": "dashboard", + "link": { + "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts", + "lineNumber": 56 + } + }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/server/migrations.ts", + "lineNumber": 245 + } + }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/server/migrations.ts", + "lineNumber": 312 + } + } ] }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsMigrationLogger.warn", "type": "Function", + "tags": [], "label": "warn", "description": [], + "signature": [ + "(msg: string) => void" + ], "source": { "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "lineNumber": 26 }, - "signature": [ - "(msg: string) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsMigrationLogger.error", "type": "Function", + "tags": [], "label": "error", "description": [], + "signature": [ + "(msg: string, meta: Meta) => void" + ], "source": { "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "lineNumber": 27 }, - "signature": [ - "(msg: string, meta: ", - "LogMeta", - ") => void" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsOpenPointInTimeOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsOpenPointInTimeOptions", + "description": [], "signature": [ { "pluginId": "core", @@ -11474,229 +12860,251 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 359 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive", "type": "string", + "tags": [], "label": "keepAlive", "description": [ "\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 360 + "lineNumber": 363 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsOpenPointInTimeOptions.preference", "type": "string", + "tags": [], "label": "preference", "description": [ "\nAn optional ES preference value to be used for the query." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 364 + "lineNumber": 367 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 356 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsOpenPointInTimeResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsOpenPointInTimeResponse", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 373 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsOpenPointInTimeResponse.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nPIT ID returned from ES." ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 374 - } + "lineNumber": 377 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 370 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsPitParams", "type": "Interface", + "tags": [], "label": "SavedObjectsPitParams", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsPitParams.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 70 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsPitParams.keepAlive", "type": "string", + "tags": [], "label": "keepAlive", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 71 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 69 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRawDoc", "type": "Interface", + "tags": [], "label": "SavedObjectsRawDoc", "description": [ "\nA raw document as represented directly in the saved object index.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsRawDoc._id", "type": "string", + "tags": [], "label": "_id", "description": [], "source": { "path": "src/core/server/saved_objects/serialization/types.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsRawDoc._source", "type": "Object", + "tags": [], "label": "_source", "description": [], + "signature": [ + "SavedObjectsRawDocSource" + ], "source": { "path": "src/core/server/saved_objects/serialization/types.ts", "lineNumber": 18 }, - "signature": [ - "SavedObjectsRawDocSource" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsRawDoc._seq_no", "type": "number", + "tags": [], "label": "_seq_no", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/server/saved_objects/serialization/types.ts", "lineNumber": 19 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsRawDoc._primary_term", "type": "number", + "tags": [], "label": "_primary_term", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/core/server/saved_objects/serialization/types.ts", "lineNumber": 20 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 16 - }, + ], "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRawDocParseOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsRawDocParseOptions", "description": [ "\nOptions that can be specified when using the saved objects serializer to parse a raw document.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 78 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment", "type": "CompoundType", + "tags": [], "label": "namespaceTreatment", "description": [ "\nOptional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously\nsingle-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade\nmigrations.\n\nIf not specified, the default treatment is `strict`." ], + "signature": [ + "\"strict\" | \"lax\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/serialization/types.ts", "lineNumber": 86 }, - "signature": [ - "\"strict\" | \"lax\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 78 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRemoveReferencesToOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsRemoveReferencesToOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -11714,40 +13122,42 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 263 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", "type": "CompoundType", + "tags": [], "label": "refresh", "description": [ "The Elasticsearch Refresh setting for this operation. Defaults to `true`" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 262 + "lineNumber": 265 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 260 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRemoveReferencesToResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsRemoveReferencesToResponse", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -11765,56 +13175,54 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 272 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", "type": "number", + "tags": [], "label": "updated", "description": [ "The number of objects that have been updated by this operation" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 271 - } + "lineNumber": 274 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 269 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepositoryFactory", "type": "Interface", + "tags": [], "label": "SavedObjectsRepositoryFactory", "description": [ "\nFactory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider}\nSee {@link SavedObjectsServiceSetup.setClientFactoryProvider}\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 226 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository", "type": "Function", + "tags": [], "label": "createScopedRepository", "description": [ "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 234 - }, "signature": [ "(req: ", { @@ -11833,20 +13241,22 @@ "text": "SavedObjectsRepository" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 234 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository", "type": "Function", + "tags": [], "label": "createInternalRepository", "description": [ "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 244 - }, "signature": [ "(includedHiddenTypes?: string[] | undefined) => Pick<", { @@ -11857,54 +13267,58 @@ "text": "SavedObjectsRepository" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 244 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 226 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsResolveImportErrorsOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsResolveImportErrorsOptions", "description": [ "\nOptions to control the \"resolve import\" operation." ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 168 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream", "type": "Object", + "tags": [], "label": "readStream", "description": [ "The stream of {@link SavedObject | saved objects} to resolve errors from" ], + "signature": [ + "Readable" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 170 }, - "signature": [ - "Readable" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsResolveImportErrorsOptions.retries", "type": "Array", + "tags": [], "label": "retries", "description": [ "saved object import references to retry" ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 172 - }, "signature": [ { "pluginId": "core", @@ -11914,28 +13328,36 @@ "text": "SavedObjectsImportRetry" }, "[]" - ] + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 172 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [ "if specified, will import in given namespace" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 174 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsResolveImportErrorsOptions.createNewCopies", "type": "boolean", + "tags": [], "label": "createNewCopies", "description": [ "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." @@ -11943,19 +13365,21 @@ "source": { "path": "src/core/server/saved_objects/import/types.ts", "lineNumber": 176 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 168 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsResolveResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsResolveResponse", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -11966,90 +13390,92 @@ }, "" ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 338 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsResolveResponse.saved_object", "type": "Object", + "tags": [], "label": "saved_object", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 336 - }, "signature": [ "SavedObject", "" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 339 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsResolveResponse.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": [ + "\"conflict\" | \"exactMatch\" | \"aliasMatch\"" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 346 + "lineNumber": 349 }, - "signature": [ - "\"conflict\" | \"exactMatch\" | \"aliasMatch\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsResolveResponse.aliasTargetId", "type": "string", + "tags": [], "label": "aliasTargetId", "description": [ "\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 350 + "lineNumber": 353 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 335 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceSetup", "type": "Interface", + "tags": [], "label": "SavedObjectsServiceSetup", "description": [ "\nSaved Objects is Kibana's data persistence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods\nfor registering Saved Object types, creating and registering Saved Object client wrappers and factories.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 85 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider", "type": "Function", + "tags": [], "label": "setClientFactoryProvider", "description": [ "\nSet the default {@link SavedObjectsClientFactoryProvider | factory provider} for creating Saved Objects clients.\nOnly one provider can be set, subsequent calls to this method will fail." ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 90 - }, "signature": [ "(clientFactoryProvider: ", { @@ -12060,20 +13486,22 @@ "text": "SavedObjectsClientFactoryProvider" }, ") => void" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 90 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceSetup.addClientWrapper", "type": "Function", + "tags": [], "label": "addClientWrapper", "description": [ "\nAdd a {@link SavedObjectsClientWrapperFactory | client wrapper factory} with the given priority." ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 95 - }, "signature": [ "(priority: number, id: string, factory: ", { @@ -12084,20 +13512,22 @@ "text": "SavedObjectsClientWrapperFactory" }, ") => void" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 95 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceSetup.registerType", "type": "Function", + "tags": [], "label": "registerType", "description": [ "\nRegister a {@link SavedObjectsType | savedObjects type} definition.\n\nSee the {@link SavedObjectsTypeMappingDefinition | mappings format} and\n{@link SavedObjectMigrationMap | migration format} for more details about these.\n" ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 144 - }, "signature": [ "(type: ", { @@ -12108,38 +13538,40 @@ "text": "SavedObjectsType" }, ") => void" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 144 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 85 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceStart", "type": "Interface", + "tags": [], "label": "SavedObjectsServiceStart", "description": [ "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The\nSavedObjectsServiceStart API provides a scoped Saved Objects client for\ninteracting with Saved Objects.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 162 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceStart.getScopedClient", "type": "Function", + "tags": [], "label": "getScopedClient", "description": [ "\nCreates a {@link SavedObjectsClientContract | Saved Objects client} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch. If other plugins have registered Saved Objects client\nwrappers, these will be applied to extend the functionality of the client.\n\nA client that is already scoped to the incoming request is also exposed\nfrom the route handler context see {@link RequestHandlerContext}." ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 172 - }, "signature": [ "(req: ", { @@ -12166,20 +13598,22 @@ "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 172 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceStart.createScopedRepository", "type": "Function", + "tags": [], "label": "createScopedRepository", "description": [ "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 188 - }, "signature": [ "(req: ", { @@ -12198,20 +13632,22 @@ "text": "SavedObjectsRepository" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 188 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceStart.createInternalRepository", "type": "Function", + "tags": [], "label": "createInternalRepository", - "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 198 - }, + "description": [ + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" + ], "signature": [ "(includedHiddenTypes?: string[] | undefined) => Pick<", { @@ -12222,20 +13658,22 @@ "text": "SavedObjectsRepository" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 198 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceStart.createSerializer", "type": "Function", + "tags": [], "label": "createSerializer", "description": [ "\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types." ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 202 - }, "signature": [ "() => ", { @@ -12245,20 +13683,22 @@ "section": "def-server.SavedObjectsSerializer", "text": "SavedObjectsSerializer" } - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 202 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceStart.createExporter", "type": "Function", + "tags": [], "label": "createExporter", "description": [ "\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client." ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 206 - }, "signature": [ "(client: Pick<", { @@ -12277,20 +13717,22 @@ "text": "SavedObjectsExporter" }, ", \"exportByTypes\" | \"exportByObjects\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 206 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceStart.createImporter", "type": "Function", + "tags": [], "label": "createImporter", "description": [ "\nCreates an {@link ISavedObjectsImporter | importer} bound to given client." ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 210 - }, "signature": [ "(client: Pick<", { @@ -12309,20 +13751,22 @@ "text": "SavedObjectsImporter" }, ", \"import\" | \"resolveImportErrors\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 210 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsServiceStart.getTypeRegistry", "type": "Function", + "tags": [], "label": "getTypeRegistry", "description": [ "\nReturns the {@link ISavedObjectTypeRegistry | registry} containing all registered\n{@link SavedObjectsType | saved object types}" ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 215 - }, "signature": [ "() => Pick<", { @@ -12333,94 +13777,102 @@ "text": "SavedObjectTypeRegistry" }, ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" - ] + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 215 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 162 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectStatusMeta", "type": "Interface", + "tags": [], "label": "SavedObjectStatusMeta", "description": [ "\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectStatusMeta.migratedIndices", "type": "Object", + "tags": [], "label": "migratedIndices", "description": [], + "signature": [ + "{ [status: string]: number; skipped: number; migrated: number; }" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 51 }, - "signature": [ - "{ [status: string]: number; skipped: number; migrated: number; }" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 50 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsType", "type": "Interface", + "tags": [], "label": "SavedObjectsType", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 256 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsType.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nThe name of the type, which is also used as the internal id." ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 238 - } + "lineNumber": 260 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsType.hidden", "type": "boolean", + "tags": [], "label": "hidden", "description": [ "\nIs the type hidden by default. If true, repositories will not have access to this type unless explicitly\ndeclared as an `extraType` when creating the repository.\n\nSee {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}." ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 245 - } + "lineNumber": 267 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsType.namespaceType", "type": "CompoundType", + "tags": [], "label": "namespaceType", "description": [ "\nThe {@link SavedObjectsNamespaceType | namespace type} for the type." ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 249 - }, "signature": [ { "pluginId": "core", @@ -12429,52 +13881,58 @@ "section": "def-server.SavedObjectsNamespaceType", "text": "SavedObjectsNamespaceType" } - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 271 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsType.indexPattern", "type": "string", + "tags": [], "label": "indexPattern", "description": [ "\nIf defined, the type instances will be stored in the given index instead of the default one." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 253 + "lineNumber": 275 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsType.convertToAliasScript", "type": "string", + "tags": [], "label": "convertToAliasScript", "description": [ "\nIf defined, will be used to convert the type to an alias." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 257 + "lineNumber": 279 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsType.mappings", "type": "Object", + "tags": [], "label": "mappings", "description": [ "\nThe {@link SavedObjectsTypeMappingDefinition | mapping definition} for the type." ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 261 - }, "signature": [ { "pluginId": "core", @@ -12483,20 +13941,22 @@ "section": "def-server.SavedObjectsTypeMappingDefinition", "text": "SavedObjectsTypeMappingDefinition" } - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 283 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsType.migrations", "type": "CompoundType", + "tags": [], "label": "migrations", "description": [ "\nAn optional map of {@link SavedObjectMigrationFn | migrations} or a function returning a map of {@link SavedObjectMigrationFn | migrations} to be used to migrate the type." ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 265 - }, "signature": [ { "pluginId": "core", @@ -12514,36 +13974,40 @@ "text": "SavedObjectMigrationMap" }, ") | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 287 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion", "type": "string", + "tags": [], "label": "convertToMultiNamespaceTypeVersion", "description": [ "\nIf defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this\nversion.\n\nRequirements:\n\n 1. This string value must be a valid semver version\n 2. This type must have previously specified {@link SavedObjectsNamespaceType | `namespaceType: 'single'`}\n 3. This type must also specify {@link SavedObjectsNamespaceType | `namespaceType: 'multiple'`} *or*\n {@link SavedObjectsNamespaceType | `namespaceType: 'multiple-isolated'`}\n\nExample of a single-namespace type in 7.12:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'single',\n mappings: {...}\n}\n```\n\nExample after converting to a multi-namespace (isolated) type in 8.0:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple-isolated',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nExample after converting to a multi-namespace (shareable) type in 8.1:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nNote: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 314 + "lineNumber": 336 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsType.management", "type": "Object", + "tags": [], "label": "management", "description": [ "\nAn optional {@link SavedObjectsTypeManagementDefinition | saved objects management section} definition for the type." ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 318 - }, "signature": [ { "pluginId": "core", @@ -12553,140 +14017,154 @@ "text": "SavedObjectsTypeManagementDefinition" }, " | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 340 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 234 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeManagementDefinition", "type": "Interface", + "tags": [], "label": "SavedObjectsTypeManagementDefinition", "description": [ "\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 348 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeManagementDefinition.importableAndExportable", "type": "CompoundType", + "tags": [], "label": "importableAndExportable", "description": [ "\nIs the type importable or exportable. Defaults to `false`." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 330 + "lineNumber": 352 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeManagementDefinition.defaultSearchField", "type": "string", + "tags": [], "label": "defaultSearchField", "description": [ "\nThe default search field to use for this type. Defaults to `id`." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 334 + "lineNumber": 356 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeManagementDefinition.icon", "type": "string", + "tags": [], "label": "icon", "description": [ "\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 339 + "lineNumber": 361 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle", "type": "Function", + "tags": [], "label": "getTitle", "description": [ "\nFunction returning the title to display in the management table.\nIf not defined, will use the object's type and id to generate a label." ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 344 - }, "signature": [ "((savedObject: ", "SavedObject", ") => string) | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 366 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl", "type": "Function", + "tags": [], "label": "getEditUrl", "description": [ "\nFunction returning the url to use to redirect to the editing page of this object.\nIf not defined, editing will not be allowed." ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 349 - }, "signature": [ "((savedObject: ", "SavedObject", ") => string) | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 371 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl", "type": "Function", + "tags": [], "label": "getInAppUrl", "description": [ "\nFunction returning the url to use to redirect to this object from the management section.\nIf not defined, redirecting to the object will not be allowed.\n" ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 358 - }, "signature": [ "((savedObject: ", "SavedObject", ") => { path: string; uiCapabilitiesPath: string; }) | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 380 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeManagementDefinition.onExport", "type": "Function", + "tags": [], "label": "onExport", "description": [ "\nAn optional export transform function that can be used transform the objects of the registered type during\nthe export process.\n\nIt can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.\n\nSee {@link SavedObjectsExportTransform | the transform type documentation} for more info and examples.\n" ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 369 - }, "signature": [ { "pluginId": "core", @@ -12696,20 +14174,22 @@ "text": "SavedObjectsExportTransform" }, " | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 391 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeManagementDefinition.onImport", "type": "Function", + "tags": [], "label": "onImport", "description": [ "\nAn optional {@link SavedObjectsImportHook | import hook} to use when importing given type.\n\nImport hooks are executed during the savedObjects import process and allow to interact\nwith the imported objects. See the {@link SavedObjectsImportHook | hook documentation}\nfor more info.\n" ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 412 - }, "signature": [ { "pluginId": "core", @@ -12719,54 +14199,58 @@ "text": "SavedObjectsImportHook" }, " | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 434 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 326 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeMappingDefinition", "type": "Interface", + "tags": [], "label": "SavedObjectsTypeMappingDefinition", "description": [ "\nDescribe a saved object type mapping.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeMappingDefinition.dynamic", "type": "CompoundType", + "tags": [], "label": "dynamic", "description": [ "The dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings." ], + "signature": [ + "false | \"strict\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/mappings/types.ts", "lineNumber": 40 }, - "signature": [ - "false | \"strict\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsTypeMappingDefinition.properties", "type": "Object", + "tags": [], "label": "properties", "description": [ "The underlying properties of the type mapping" ], - "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 42 - }, "signature": [ { "pluginId": "core", @@ -12775,19 +14259,25 @@ "section": "def-server.SavedObjectsMappingProperties", "text": "SavedObjectsMappingProperties" } - ] + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 42 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 36 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsUpdateOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsUpdateOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -12796,7 +14286,7 @@ "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, - " extends ", + " extends ", { "pluginId": "core", "scope": "server", @@ -12805,73 +14295,97 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 210 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsUpdateOptions.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" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 211 + "lineNumber": 212 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsUpdateOptions.references", "type": "Array", + "tags": [], "label": "references", "description": [ "{@inheritdoc SavedObjectReference}" ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 213 - }, "signature": [ "SavedObjectReference", "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 214 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsUpdateOptions.refresh", "type": "CompoundType", + "tags": [], "label": "refresh", "description": [ "The Elasticsearch Refresh setting for this operation" ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 215 + "lineNumber": 216 }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateOptions.upsert", + "type": "Uncategorized", + "tags": [], + "label": "upsert", + "description": [ + "If specified, will be used to perform an upsert if the document doesn't exist" + ], "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "Attributes | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 218 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 209 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsUpdateResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsUpdateResponse", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -12884,64 +14398,58 @@ "SavedObject", ", \"type\" | \"id\" | \"version\" | \"namespaces\" | \"updated_at\" | \"error\" | \"migrationVersion\" | \"coreMigrationVersion\" | \"originId\">" ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 328 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsUpdateResponse.attributes", "type": "Object", + "tags": [], "label": "attributes", "description": [], + "signature": [ + "Partial" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 327 + "lineNumber": 330 }, - "signature": [ - "Partial" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsUpdateResponse.references", "type": "Array", + "tags": [], "label": "references", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 328 - }, "signature": [ "SavedObjectReference", "[] | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 331 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 325 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "core", "id": "def-server.ISavedObjectsExporter", "type": "Type", + "tags": [], "label": "ISavedObjectsExporter", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 31 - }, "signature": [ "{ exportByTypes: (options: SavedObjectsExportByTypeOptions) => Promise<", "Readable", @@ -12949,96 +14457,96 @@ "Readable", ">; }" ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 31 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ISavedObjectsImporter", "type": "Type", + "tags": [], "label": "ISavedObjectsImporter", - "tags": [ - "public" - ], "description": [], + "signature": [ + "{ import: ({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions) => Promise; resolveImportErrors: ({ readStream, createNewCopies, namespace, retries, }: SavedObjectsResolveImportErrorsOptions) => Promise; }" + ], "source": { "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "lineNumber": 24 }, - "signature": [ - "{ import: ({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions) => Promise; resolveImportErrors: ({ readStream, createNewCopies, namespace, retries, }: SavedObjectsResolveImportErrorsOptions) => Promise; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ISavedObjectsRepository", "type": "Type", + "tags": [], "label": "ISavedObjectsRepository", - "tags": [ - "public" - ], "description": [ "\nSee {@link SavedObjectsRepository}\n" ], + "signature": [ + "{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions) => Promise<{}>; create: (type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise>; bulkCreate: (objects: SavedObjectsBulkCreateObject[], options?: SavedObjectsCreateOptions) => Promise>; checkConflicts: (objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions) => Promise; deleteByNamespace: (namespace: string, options?: SavedObjectsDeleteByNamespaceOptions) => Promise; find: (options: SavedObjectsFindOptions) => Promise>; bulkGet: (objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions) => Promise>; resolve: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; update: (type: string, id: string, attributes: Partial, options?: SavedObjectsUpdateOptions) => Promise>; addToNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsAddToNamespacesOptions) => Promise; deleteFromNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsDeleteFromNamespacesOptions) => Promise; bulkUpdate: (objects: SavedObjectsBulkUpdateObject[], options?: SavedObjectsBulkUpdateOptions) => Promise>; removeReferencesTo: (type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions) => Promise; incrementCounter: (type: string, id: string, counterFields: (string | SavedObjectsIncrementCounterField)[], options?: SavedObjectsIncrementCounterOptions) => Promise>; openPointInTimeForType: (type: string | string[], { keepAlive, preference }?: SavedObjectsOpenPointInTimeOptions) => Promise; closePointInTime: (id: string, options?: SavedObjectsBaseOptions | undefined) => Promise; createPointInTimeFinder: (findOptions: Pick, dependencies?: SavedObjectsCreatePointInTimeFinderDependencies | undefined) => ISavedObjectsPointInTimeFinder; }" + ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 143 + "lineNumber": 144 }, - "signature": [ - "{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions) => Promise<{}>; create: (type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise>; bulkCreate: (objects: SavedObjectsBulkCreateObject[], options?: SavedObjectsCreateOptions) => Promise>; checkConflicts: (objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions) => Promise; deleteByNamespace: (namespace: string, options?: SavedObjectsDeleteByNamespaceOptions) => Promise; find: (options: SavedObjectsFindOptions) => Promise>; bulkGet: (objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions) => Promise>; resolve: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; update: (type: string, id: string, attributes: Partial, options?: SavedObjectsUpdateOptions) => Promise>; addToNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsAddToNamespacesOptions) => Promise; deleteFromNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsDeleteFromNamespacesOptions) => Promise; bulkUpdate: (objects: SavedObjectsBulkUpdateObject[], options?: SavedObjectsBulkUpdateOptions) => Promise>; removeReferencesTo: (type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions) => Promise; incrementCounter: (type: string, id: string, counterFields: (string | SavedObjectsIncrementCounterField)[], options?: SavedObjectsIncrementCounterOptions) => Promise>; openPointInTimeForType: (type: string | string[], { keepAlive, preference }?: SavedObjectsOpenPointInTimeOptions) => Promise; closePointInTime: (id: string, options?: SavedObjectsBaseOptions | undefined) => Promise; createPointInTimeFinder: (findOptions: Pick, dependencies?: SavedObjectsCreatePointInTimeFinderDependencies | undefined) => ISavedObjectsPointInTimeFinder; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.ISavedObjectTypeRegistry", "type": "Type", + "tags": [], "label": "ISavedObjectTypeRegistry", - "tags": [ - "public" - ], "description": [ "\nSee {@link SavedObjectTypeRegistry} for documentation.\n" ], + "signature": [ + "{ getType: (type: string) => SavedObjectsType | undefined; getVisibleTypes: () => SavedObjectsType[]; getAllTypes: () => SavedObjectsType[]; getImportableAndExportableTypes: () => 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; }" + ], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "lineNumber": 17 }, - "signature": [ - "{ getType: (type: string) => SavedObjectsType | undefined; getVisibleTypes: () => SavedObjectsType[]; getAllTypes: () => SavedObjectsType[]; getImportableAndExportableTypes: () => 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; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.MutatingOperationRefreshSetting", "type": "Type", + "tags": [], "label": "MutatingOperationRefreshSetting", - "tags": [ - "public" - ], "description": [ "\nElasticsearch Refresh setting for mutating operation" ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 149 - }, "signature": [ "false | true | \"wait_for\"" ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 171 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectMigrationFn", "type": "Type", + "tags": [], "label": "SavedObjectMigrationFn", - "tags": [ - "public" - ], "description": [ "\nA migration function for a {@link SavedObjectsType | saved object type}\nused to migrate it to a given version\n" ], - "source": { - "path": "src/core/server/saved_objects/migrations/types.ts", - "lineNumber": 45 - }, "signature": [ "(doc: ", { @@ -13066,41 +14574,41 @@ }, "" ], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 45 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectSanitizedDoc", "type": "Type", + "tags": [], "label": "SavedObjectSanitizedDoc", - "tags": [ - "public" - ], "description": [ "\nDescribes Saved Object documents that have passed through the migration\nframework and are guaranteed to have a `references` root property.\n" ], + "signature": [ + "SavedObjectDoc & Referencable" + ], "source": { "path": "src/core/server/saved_objects/serialization/types.ts", "lineNumber": 71 }, - "signature": [ - "SavedObjectDoc & Referencable" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClientContract", "type": "Type", + "tags": [], "label": "SavedObjectsClientContract", - "tags": [ - "public" - ], "description": [ "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state.\n\n## SavedObjectsClient errors\n\nSince the SavedObjectsClient has its hands in everything we\nare a little paranoid about the way we present errors back to\nto application code. Ideally, all errors will be either:\n\n 1. Caused by bad implementation (ie. undefined is not a function) and\n as such unpredictable\n 2. An error that has been classified and decorated appropriately\n by the decorators in {@link SavedObjectsErrorHelpers}\n\nType 1 errors are inevitable, but since all expected/handle-able errors\nshould be Type 2 the `isXYZError()` helpers exposed at\n`SavedObjectsErrorHelpers` should be used to understand and manage error\nresponses from the `SavedObjectsClient`.\n\nType 2 errors are decorated versions of the source error, so if\nthe elasticsearch client threw an error it will be decorated based\non its type. That means that rather than looking for `error.body.error.type` or\ndoing substring checks on `error.body.error.reason`, just use the helpers to\nunderstand the meaning of the error:\n\n ```js\n if (SavedObjectsErrorHelpers.isNotFoundError(error)) {\n // handle 404\n }\n\n if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) {\n // 401 handling should be automatic, but in case you wanted to know\n }\n\n // always rethrow the error unless you handle it\n throw error;\n ```\n\n### 404s from missing index\n\nFrom the perspective of application code and APIs the SavedObjectsClient is\na black box that persists objects. One of the internal details that users have\nno control over is that we use an elasticsearch index for persistance and that\nindex might be missing.\n\nAt the time of writing we are in the process of transitioning away from the\noperating assumption that the SavedObjects index is always available. Part of\nthis transition is handling errors resulting from an index missing. These used\nto trigger a 500 error in most cases, and in others cause 404s with different\nerror messages.\n\nFrom my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The\nobject the request/call was targeting could not be found. This is why #14141\ntakes special care to ensure that 404 errors are generic and don't distinguish\nbetween index missing or document missing.\n\nSee {@link SavedObjectsClient}\nSee {@link SavedObjectsErrorHelpers}\n" ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 213 - }, "signature": [ "{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: ", { @@ -13143,22 +14651,22 @@ "text": "SavedObjectsBulkResponse" } ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 235 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClientFactory", "type": "Type", + "tags": [], "label": "SavedObjectsClientFactory", - "tags": [ - "public" - ], "description": [ "\nDescribes the factory used to create instances of the Saved Objects Client." ], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 37 - }, "signature": [ "(__0: { request: ", { @@ -13178,22 +14686,22 @@ }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 37 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClientFactoryProvider", "type": "Type", + "tags": [], "label": "SavedObjectsClientFactoryProvider", - "tags": [ - "public" - ], "description": [ "\nProvider to invoke to retrieve a {@link SavedObjectsClientFactory}." ], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 49 - }, "signature": [ "(repositoryFactory: ", { @@ -13212,22 +14720,22 @@ "text": "SavedObjectsClientFactory" } ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 49 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClientWrapperFactory", "type": "Type", + "tags": [], "label": "SavedObjectsClientWrapperFactory", - "tags": [ - "public" - ], "description": [ "\nDescribes the factory used to create instances of Saved Objects Client Wrappers." ], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 29 - }, "signature": [ "(options: ", { @@ -13247,39 +14755,39 @@ }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 29 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClosePointInTimeOptions", "type": "Type", + "tags": [], "label": "SavedObjectsClosePointInTimeOptions", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 380 - }, "signature": [ "SavedObjectsBaseOptions" ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 383 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsCreatePointInTimeFinderOptions", "type": "Type", + "tags": [], "label": "SavedObjectsCreatePointInTimeFinderOptions", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "lineNumber": 21 - }, "signature": [ - "{ type: string | string[]; filter?: any; fields?: string[] | undefined; search?: string | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | \"_doc\" | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ", + "{ type: string | string[]; filter?: any; aggs?: Record | undefined; fields?: string[] | undefined; preference?: string | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | \"_doc\" | undefined; search?: string | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ", { "pluginId": "core", "scope": "server", @@ -13295,24 +14803,24 @@ "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, - "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; preference?: string | undefined; }" + "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; }" ], + "source": { + "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsExportTransform", "type": "Type", + "tags": [], "label": "SavedObjectsExportTransform", - "tags": [ - "public" - ], "description": [ "\nTransformation function used to mutate the exported objects of the associated type.\n\nA type's export transform function will be executed once per user-initiated export,\nfor all objects of that type.\n" ], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 155 - }, "signature": [ "(context: ", { @@ -13330,22 +14838,22 @@ "SavedObject", "[]>" ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 155 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsFieldMapping", "type": "Type", + "tags": [], "label": "SavedObjectsFieldMapping", - "tags": [ - "public" - ], "description": [ "\nDescribe a {@link SavedObjectsTypeMappingDefinition | saved object type mapping} field.\n\nPlease refer to {@link https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html | elasticsearch documentation}\nFor the mapping documentation\n" ], - "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 99 - }, "signature": [ { "pluginId": "core", @@ -13363,22 +14871,22 @@ "text": "SavedObjectsCoreFieldMapping" } ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 99 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportHook", "type": "Type", + "tags": [], "label": "SavedObjectsImportHook", - "tags": [ - "public" - ], "description": [ "\nA hook associated with a specific saved object type, that will be invoked during\nthe import process. The hook will have access to the objects of the registered type.\n\nCurrently, the only supported feature for import hooks is to return warnings to be displayed\nin the UI when the import succeeds.\n" ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 246 - }, "signature": [ "(objects: ", "SavedObject", @@ -13400,22 +14908,22 @@ }, ">" ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 246 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsImportWarning", "type": "Type", + "tags": [], "label": "SavedObjectsImportWarning", - "tags": [ - "public" - ], "description": [ "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 218 - }, "signature": [ { "pluginId": "core", @@ -13433,44 +14941,49 @@ "text": "SavedObjectsImportActionRequiredWarning" } ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 218 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsNamespaceType", "type": "Type", + "tags": [], "label": "SavedObjectsNamespaceType", - "tags": [ - "public" - ], "description": [ "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 227 - }, "signature": [ "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 249 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectUnsanitizedDoc", "type": "Type", + "tags": [], "label": "SavedObjectUnsanitizedDoc", - "tags": [ - "public" - ], "description": [ "\nDescribes Saved Object documents from Kibana < 7.0.0 which don't have a\n`references` root property defined. This type should only be used in\nmigrations.\n" ], + "signature": [ + "SavedObjectDoc & Partial" + ], "source": { "path": "src/core/server/saved_objects/serialization/types.ts", "lineNumber": 63 }, - "signature": [ - "SavedObjectDoc & Partial" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/dashboard.json b/api_docs/dashboard.json index 36091a64a414a..94bd115676741 100644 --- a/api_docs/dashboard.json +++ b/api_docs/dashboard.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer", "type": "Class", "tags": [], @@ -43,31 +44,35 @@ "text": "ContainerOutput" } ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 103 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"dashboard\"" + ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 104 }, - "signature": [ - "\"dashboard\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.switchViewMode", "type": "Function", + "tags": [], "label": "switchViewMode", "description": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 105 - }, "signature": [ "((newViewMode: ", { @@ -78,38 +83,54 @@ "text": "ViewMode" }, ") => void) | undefined" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 105 + }, + "deprecated": false }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.getPanelCount", "type": "Function", - "children": [], + "tags": [], + "label": "getPanelCount", + "description": [], "signature": [ "() => number" ], - "description": [], - "label": "getPanelCount", "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 107 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 111 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.Unnamed.$1", "type": "Object", + "tags": [], "label": "initialInput", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "dashboard", @@ -119,31 +140,37 @@ "text": "DashboardContainerInput" } ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 112 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.Unnamed.$2", "type": "Object", + "tags": [], "label": "services", - "isRequired": true, + "description": [], "signature": [ "DashboardContainerServices" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 113 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.Unnamed.$3", "type": "Object", + "tags": [], "label": "parent", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -170,24 +197,23 @@ }, "> | undefined" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 114 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 111 - } + "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.createNewPanelState", "type": "Function", + "tags": [], "label": "createNewPanelState", + "description": [], "signature": [ ", partial?: Partial) => ", "DashboardPanelState" ], - "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 127 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.createNewPanelState.$1", "type": "Object", + "tags": [], "label": "factory", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -237,38 +269,40 @@ "SavedObjectAttributes", ">" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 131 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.createNewPanelState.$2", "type": "Object", + "tags": [], "label": "partial", - "isRequired": true, + "description": [], "signature": [ "Partial" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 132 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 127 - } + "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.showPlaceholderUntil", "type": "Function", + "tags": [], "label": "showPlaceholderUntil", + "description": [], "signature": [ " | undefined, placementArgs?: TPlacementMethodArgs | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 138 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.showPlaceholderUntil.$1", "type": "Object", + "tags": [], "label": "newStateComplete", - "isRequired": true, + "description": [], "signature": [ "Promise>>" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 139 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.showPlaceholderUntil.$2", "type": "Function", + "tags": [], "label": "placementMethod", - "isRequired": false, + "description": [], "signature": [ "PanelPlacementMethod", " | undefined" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 140 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.showPlaceholderUntil.$3", "type": "Uncategorized", + "tags": [], "label": "placementArgs", - "isRequired": false, + "description": [], "signature": [ "TPlacementMethodArgs | undefined" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 141 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 138 - } + "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.replacePanel", "type": "Function", + "tags": [], "label": "replacePanel", + "description": [], "signature": [ "(previousPanelState: ", "DashboardPanelState", @@ -370,13 +415,19 @@ }, "<{ id: string; }>>, generateNewId?: boolean | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 179 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.replacePanel.$1", "type": "Object", + "tags": [], "label": "previousPanelState", - "isRequired": true, + "description": [], "signature": [ "DashboardPanelState", "<", @@ -389,17 +440,20 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 180 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.replacePanel.$2", "type": "Object", + "tags": [], "label": "newPanelState", - "isRequired": true, + "description": [], "signature": [ "Partial<", { @@ -411,38 +465,40 @@ }, "<{ id: string; }>>" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 181 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.replacePanel.$3", "type": "CompoundType", + "tags": [], "label": "generateNewId", - "isRequired": false, + "description": [], "signature": [ "boolean | undefined" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 182 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 179 - } + "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.addOrUpdateEmbeddable", "type": "Function", + "tags": [], "label": "addOrUpdateEmbeddable", + "description": [], "signature": [ "" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 230 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.addOrUpdateEmbeddable.$3", "type": "string", + "tags": [], "label": "embeddableId", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 230 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 226 - } + "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.render", "type": "Function", + "tags": [], "label": "render", + "description": [], "signature": [ "(dom: HTMLElement) => void" ], - "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 244 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.render.$1", "type": "Object", + "tags": [], "label": "dom", - "isRequired": true, + "description": [], "signature": [ "HTMLElement" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 244 - } + "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.getInheritedInput", "type": "Function", + "tags": [], "label": "getInheritedInput", + "description": [], "signature": [ "(id: string) => ", "InheritedChildInput" ], - "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 255 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainer.getInheritedInput.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 255 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 255 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 103 - }, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition", "type": "Class", "tags": [], @@ -654,104 +725,148 @@ "text": "DashboardContainer" } ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.isContainerType", "type": "boolean", + "tags": [], "label": "isContainerType", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 32 + "lineNumber": 37 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"dashboard\"" + ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 33 + "lineNumber": 38 }, - "signature": [ - "\"dashboard\"" - ] + "deprecated": false }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.Unnamed.$1", "type": "Function", + "tags": [], "label": "getStartServices", - "isRequired": true, + "description": [], "signature": [ "() => Promise<", "DashboardContainerServices", ">" ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 41 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dashboard", + "id": "def-public.DashboardContainerFactoryDefinition.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "persistableStateService", "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddablePersistableStateService", + "text": "EmbeddablePersistableStateService" + } + ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 35 - } + "lineNumber": 42 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 35 - } + "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.isEditable", "type": "Function", - "children": [], + "tags": [], + "label": "isEditable", + "description": [], "signature": [ "() => Promise" ], - "description": [], - "label": "isEditable", "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 37 + "lineNumber": 45 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.getDisplayName", "type": "Function", - "children": [], + "tags": [], + "label": "getDisplayName", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getDisplayName", "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 42 + "lineNumber": 50 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.getDefaultInput", "type": "Function", + "tags": [], "label": "getDefaultInput", + "description": [], "signature": [ "() => Partial<", { @@ -763,24 +878,76 @@ }, ">" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 48 - } + "lineNumber": 56 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.create", "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "(initialInput: ", + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainerInput", + "text": "DashboardContainerInput" + }, + ", parent?: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Container", + "text": "Container" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + "> | undefined) => Promise<", + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainer", + "text": "DashboardContainer" + } + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 66 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.create.$1", "type": "Object", + "tags": [], "label": "initialInput", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "dashboard", @@ -790,17 +957,20 @@ "text": "DashboardContainerInput" } ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 59 - } + "lineNumber": 67 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.create.$2", "type": "Object", + "tags": [], "label": "parent", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -827,146 +997,149 @@ }, "> | undefined" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 60 - } + "lineNumber": 68 + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [] + }, + { + "parentPluginId": "dashboard", + "id": "def-public.DashboardContainerFactoryDefinition.inject", + "type": "Function", + "tags": [], + "label": "inject", + "description": [], "signature": [ - "(initialInput: ", + "(state: ", { - "pluginId": "dashboard", - "scope": "public", - "docId": "kibDashboardPluginApi", - "section": "def-public.DashboardContainerInput", - "text": "DashboardContainerInput" + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" }, - ", parent?: ", + ", references: ", + "SavedObjectReference", + "[]) => ", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.Container", - "text": "Container" - }, - "<{}, ", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + } + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 74 + }, + "deprecated": false + }, + { + "parentPluginId": "dashboard", + "id": "def-public.DashboardContainerFactoryDefinition.extract", + "type": "Function", + "tags": [], + "label": "extract", + "description": [], + "signature": [ + "(state: ", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" }, - "<{}>, ", + ") => { state: ", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" }, - "> | undefined) => Promise<", - { - "pluginId": "dashboard", - "scope": "public", - "docId": "kibDashboardPluginApi", - "section": "def-public.DashboardContainer", - "text": "DashboardContainer" - } + "; references: ", + "SavedObjectReference", + "[]; }" ], - "description": [], - "label": "create", "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 58 + "lineNumber": 76 }, - "tags": [], - "returnComment": [] + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 29 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "dashboard", "id": "def-public.createDashboardEditUrl", "type": "Function", + "tags": [], "label": "createDashboardEditUrl", + "description": [], "signature": [ "(id: string | undefined, editMode: boolean | undefined) => string" ], - "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-public.createDashboardEditUrl.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "dashboard", "id": "def-public.createDashboardEditUrl.$2", "type": "CompoundType", + "tags": [], "label": "editMode", - "isRequired": false, + "description": [], "signature": [ "boolean | undefined" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/dashboard/public/dashboard_constants.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-public.createDashboardUrlGenerator", "type": "Function", - "children": [ - { - "id": "def-public.createDashboardUrlGenerator.$1", - "type": "Function", - "label": "getStartServices", - "isRequired": true, - "signature": [ - "() => Promise<{ appBasePath: string; useHashedUrl: boolean; savedDashboardLoader: ", - { - "pluginId": "savedObjects", - "scope": "public", - "docId": "kibSavedObjectsPluginApi", - "section": "def-public.SavedObjectLoader", - "text": "SavedObjectLoader" - }, - "; }>" - ], - "description": [], - "source": { - "path": "src/plugins/dashboard/public/url_generator.ts", - "lineNumber": 92 - } - } - ], + "tags": [], + "label": "createDashboardUrlGenerator", + "description": [], "signature": [ "(getStartServices: () => Promise<{ appBasePath: string; useHashedUrl: boolean; savedDashboardLoader: ", { @@ -986,22 +1159,50 @@ }, "<\"DASHBOARD_APP_URL_GENERATOR\">" ], - "description": [], - "label": "createDashboardUrlGenerator", "source": { "path": "src/plugins/dashboard/public/url_generator.ts", "lineNumber": 91 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "dashboard", + "id": "def-public.createDashboardUrlGenerator.$1", + "type": "Function", + "tags": [], + "label": "getStartServices", + "description": [], + "signature": [ + "() => Promise<{ appBasePath: string; useHashedUrl: boolean; savedDashboardLoader: ", + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObjectLoader", + "text": "SavedObjectLoader" + }, + "; }>" + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 92 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput", "type": "Interface", + "tags": [], "label": "DashboardContainerInput", + "description": [], "signature": [ { "pluginId": "dashboard", @@ -1020,34 +1221,36 @@ }, "<{}>" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.dashboardCapabilities", "type": "Object", + "tags": [], "label": "dashboardCapabilities", "description": [], + "signature": [ + "DashboardCapabilities", + " | undefined" + ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 43 }, - "signature": [ - "DashboardCapabilities", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.refreshConfig", "type": "Object", + "tags": [], "label": "refreshConfig", "description": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 44 - }, "signature": [ { "pluginId": "data", @@ -1057,57 +1260,65 @@ "text": "RefreshInterval" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 44 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.isEmbeddedExternally", "type": "CompoundType", + "tags": [], "label": "isEmbeddedExternally", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 45 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.isFullScreenMode", "type": "boolean", + "tags": [], "label": "isFullScreenMode", "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 46 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.expandedPanelId", "type": "string", + "tags": [], "label": "expandedPanelId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 47 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.timeRange", "type": "Object", + "tags": [], "label": "timeRange", "description": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 48 - }, "signature": [ { "pluginId": "data", @@ -1116,57 +1327,65 @@ "section": "def-common.TimeRange", "text": "TimeRange" } - ] + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 48 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.description", "type": "string", + "tags": [], "label": "description", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 49 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.useMargins", "type": "boolean", + "tags": [], "label": "useMargins", "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 50 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.syncColors", "type": "CompoundType", + "tags": [], "label": "syncColors", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 51 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.viewMode", "type": "Enum", + "tags": [], "label": "viewMode", "description": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 52 - }, "signature": [ { "pluginId": "embeddable", @@ -1175,18 +1394,20 @@ "section": "def-common.ViewMode", "text": "ViewMode" } - ] + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 52 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.filters", "type": "Array", + "tags": [], "label": "filters", "description": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 53 - }, "signature": [ { "pluginId": "data", @@ -1196,29 +1417,33 @@ "text": "Filter" }, "[]" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 53 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "lineNumber": 54 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.query", "type": "Object", + "tags": [], "label": "query", "description": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 55 - }, "signature": [ { "pluginId": "data", @@ -1227,18 +1452,20 @@ "section": "def-common.Query", "text": "Query" } - ] + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.panels", "type": "Object", + "tags": [], "label": "panels", "description": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 56 - }, "signature": [ "{ [panelId: string]: ", "DashboardPanelState", @@ -1251,44 +1478,52 @@ "text": "EmbeddableInput" }, " & { [k: string]: unknown; }>; }" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 56 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 42 - }, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardFeatureFlagConfig", "type": "Interface", + "tags": [], "label": "DashboardFeatureFlagConfig", "description": [], - "tags": [], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 91 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardFeatureFlagConfig.allowByValueEmbeddables", "type": "boolean", + "tags": [], "label": "allowByValueEmbeddables", "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 90 - } + "lineNumber": 92 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 89 - }, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject", "type": "Interface", + "tags": [], "label": "DashboardSavedObject", + "description": [], "signature": [ { "pluginId": "dashboard", @@ -1306,136 +1541,154 @@ "text": "SavedObject" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.timeRestore", "type": "boolean", + "tags": [], "label": "timeRestore", "description": [], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.timeTo", "type": "string", + "tags": [], "label": "timeTo", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.timeFrom", "type": "string", + "tags": [], "label": "timeFrom", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 22 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.description", "type": "string", + "tags": [], "label": "description", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 23 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.panelsJSON", "type": "string", + "tags": [], "label": "panelsJSON", "description": [], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.optionsJSON", "type": "string", + "tags": [], "label": "optionsJSON", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 25 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.uiStateJSON", "type": "string", + "tags": [], "label": "uiStateJSON", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 27 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.lastSavedTitle", "type": "string", + "tags": [], "label": "lastSavedTitle", "description": [], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.refreshInterval", "type": "Object", + "tags": [], "label": "refreshInterval", "description": [], - "source": { - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 29 - }, "signature": [ { "pluginId": "data", @@ -1445,18 +1698,20 @@ "text": "RefreshInterval" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.searchSource", "type": "Object", + "tags": [], "label": "searchSource", "description": [], - "source": { - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 30 - }, "signature": [ "Pick<", { @@ -1467,12 +1722,20 @@ "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 30 + }, + "deprecated": false }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.getQuery", "type": "Function", + "tags": [], "label": "getQuery", + "description": [], "signature": [ "() => ", { @@ -1483,19 +1746,21 @@ "text": "Query" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.getFilters", "type": "Function", + "tags": [], "label": "getFilters", + "description": [], "signature": [ "() => ", { @@ -1507,71 +1772,73 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.getFullEditPath", "type": "Function", + "tags": [], "label": "getFullEditPath", "description": [], + "signature": [ + "(editMode?: boolean | undefined) => string" + ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 33 }, - "signature": [ - "(editMode?: boolean | undefined) => string" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState", "type": "Interface", + "tags": [], "label": "DashboardUrlGeneratorState", "description": [], - "tags": [], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.dashboardId", "type": "string", + "tags": [], "label": "dashboardId", "description": [ "\nIf given, the dashboard saved object with this id will be loaded. If not given,\na new, unsaved dashboard will be loaded up." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/url_generator.ts", "lineNumber": 34 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.timeRange", "type": "Object", + "tags": [], "label": "timeRange", "description": [ "\nOptionally set the time range in the time picker." ], - "source": { - "path": "src/plugins/dashboard/public/url_generator.ts", - "lineNumber": 38 - }, "signature": [ { "pluginId": "data", @@ -1581,20 +1848,22 @@ "text": "TimeRange" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 38 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.refreshInterval", "type": "Object", + "tags": [], "label": "refreshInterval", "description": [ "\nOptionally set the refresh interval." ], - "source": { - "path": "src/plugins/dashboard/public/url_generator.ts", - "lineNumber": 43 - }, "signature": [ { "pluginId": "data", @@ -1604,20 +1873,22 @@ "text": "RefreshInterval" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 43 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.filters", "type": "Array", + "tags": [], "label": "filters", "description": [ "\nOptionally apply filers. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has filters saved with it, this will _replace_ those filters." ], - "source": { - "path": "src/plugins/dashboard/public/url_generator.ts", - "lineNumber": 49 - }, "signature": [ { "pluginId": "data", @@ -1627,20 +1898,22 @@ "text": "Filter" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 49 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.query", "type": "Object", + "tags": [], "label": "query", "description": [ "\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query." ], - "source": { - "path": "src/plugins/dashboard/public/url_generator.ts", - "lineNumber": 54 - }, "signature": [ { "pluginId": "data", @@ -1650,52 +1923,58 @@ "text": "Query" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 54 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.useHash", "type": "CompoundType", + "tags": [], "label": "useHash", "description": [ "\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/dashboard/public/url_generator.ts", "lineNumber": 59 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.preserveSavedFilters", "type": "CompoundType", + "tags": [], "label": "preserveSavedFilters", "description": [ "\nWhen `true` filters from saved filters from destination dashboard as merged with applied filters\nWhen `false` applied filters take precedence and override saved filters\n\ntrue is default" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/dashboard/public/url_generator.ts", "lineNumber": 67 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.viewMode", "type": "CompoundType", + "tags": [], "label": "viewMode", "description": [ "\nView mode of the dashboard." ], - "source": { - "path": "src/plugins/dashboard/public/url_generator.ts", - "lineNumber": 72 - }, "signature": [ { "pluginId": "embeddable", @@ -1705,36 +1984,40 @@ "text": "ViewMode" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 72 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.searchSessionId", "type": "string", + "tags": [], "label": "searchSessionId", "description": [ "\nSearch search session ID to restore.\n(Background search)" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/url_generator.ts", "lineNumber": 78 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.panels", "type": "Array", + "tags": [], "label": "panels", "description": [ "\nList of dashboard panels" ], - "source": { - "path": "src/plugins/dashboard/public/url_generator.ts", - "lineNumber": 83 - }, "signature": [ { "pluginId": "dashboard", @@ -1744,234 +2027,268 @@ "text": "SavedDashboardPanel730ToLatest" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 83 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.savedQuery", "type": "string", + "tags": [], "label": "savedQuery", "description": [ "\nSaved query ID" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/dashboard/public/url_generator.ts", "lineNumber": 88 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/public/url_generator.ts", - "lineNumber": 29 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DASHBOARD_APP_URL_GENERATOR", "type": "string", + "tags": [], "label": "DASHBOARD_APP_URL_GENERATOR", "description": [], + "signature": [ + "\"DASHBOARD_APP_URL_GENERATOR\"" + ], "source": { "path": "src/plugins/dashboard/public/url_generator.ts", "lineNumber": 27 }, - "signature": [ - "\"DASHBOARD_APP_URL_GENERATOR\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DASHBOARD_CONTAINER_TYPE", "type": "string", + "tags": [], "label": "DASHBOARD_CONTAINER_TYPE", "description": [], + "signature": [ + "\"dashboard\"" + ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_constants.ts", "lineNumber": 13 }, - "signature": [ - "\"dashboard\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGenerator", "type": "Type", - "label": "DashboardUrlGenerator", "tags": [], + "label": "DashboardUrlGenerator", "description": [], - "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 87 - }, "signature": [ "UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">" ], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 89 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-public.SavedDashboardPanel", "type": "Type", - "label": "SavedDashboardPanel", "tags": [], + "label": "SavedDashboardPanel", "description": [ "\nThis should always represent the latest dashboard panel shape, after all possible migrations." ], + "signature": [ + "Pick & { readonly id?: string | undefined; readonly type: string; }" + ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 33 + "lineNumber": 38 }, - "signature": [ - "Pick & { readonly id?: string | undefined; readonly type: string; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "dashboard", "id": "def-public.DashboardConstants", "type": "Object", "tags": [], + "label": "DashboardConstants", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardConstants.LANDING_PAGE_PATH", "type": "string", + "tags": [], "label": "LANDING_PAGE_PATH", "description": [], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardConstants.CREATE_NEW_DASHBOARD_URL", "type": "string", + "tags": [], "label": "CREATE_NEW_DASHBOARD_URL", "description": [], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardConstants.VIEW_DASHBOARD_URL", "type": "string", + "tags": [], "label": "VIEW_DASHBOARD_URL", "description": [], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardConstants.ADD_EMBEDDABLE_ID", "type": "string", + "tags": [], "label": "ADD_EMBEDDABLE_ID", "description": [], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardConstants.ADD_EMBEDDABLE_TYPE", "type": "string", + "tags": [], "label": "ADD_EMBEDDABLE_TYPE", "description": [], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardConstants.DASHBOARDS_ID", "type": "string", + "tags": [], "label": "DASHBOARDS_ID", "description": [], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardConstants.DASHBOARD_ID", "type": "string", + "tags": [], "label": "DASHBOARD_ID", "description": [], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardConstants.SEARCH_SESSION_ID", "type": "string", + "tags": [], "label": "SEARCH_SESSION_ID", "description": [], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", "lineNumber": 19 - } + }, + "deprecated": false } ], - "description": [], - "label": "DashboardConstants", - "source": { - "path": "src/plugins/dashboard/public/dashboard_constants.ts", - "lineNumber": 11 - }, "initialIsOpen": false } ], "setup": { + "parentPluginId": "dashboard", "id": "def-public.DashboardSetup", "type": "Type", - "label": "DashboardSetup", "tags": [], + "label": "DashboardSetup", "description": [], - "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 120 - }, "signature": [ "void" ], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 123 + }, + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "dashboard", "id": "def-public.DashboardStart", "type": "Interface", + "tags": [], "label": "DashboardStart", "description": [], - "tags": [], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 125 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardStart.getSavedDashboardLoader", "type": "Function", + "tags": [], "label": "getSavedDashboardLoader", "description": [], - "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 123 - }, "signature": [ "() => ", { @@ -1981,18 +2298,36 @@ "section": "def-public.SavedObjectLoader", "text": "SavedObjectLoader" } - ] + ], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 126 + }, + "deprecated": false }, { + "parentPluginId": "dashboard", + "id": "def-public.DashboardStart.getDashboardContainerByValueRenderer", + "type": "Function", "tags": [], - "id": "def-public.DashboardStart.dashboardUrlGenerator", - "type": "Object", - "label": "dashboardUrlGenerator", + "label": "getDashboardContainerByValueRenderer", "description": [], + "signature": [ + "() => React.FC" + ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 124 + "lineNumber": 127 }, + "deprecated": false + }, + { + "parentPluginId": "dashboard", + "id": "def-public.DashboardStart.dashboardUrlGenerator", + "type": "Object", + "tags": [], + "label": "dashboardUrlGenerator", + "description": [], "signature": [ { "pluginId": "dashboard", @@ -2002,18 +2337,20 @@ "text": "DashboardUrlGenerator" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 130 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardStart.dashboardFeatureFlagConfig", "type": "Object", + "tags": [], "label": "dashboardFeatureFlagConfig", "description": [], - "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 125 - }, "signature": [ { "pluginId": "dashboard", @@ -2022,27 +2359,14 @@ "section": "def-public.DashboardFeatureFlagConfig", "text": "DashboardFeatureFlagConfig" } - ] - }, - { - "tags": [], - "id": "def-public.DashboardStart.DashboardContainerByValueRenderer", - "type": "Function", - "label": "DashboardContainerByValueRenderer", - "description": [], + ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 126 + "lineNumber": 131 }, - "signature": [ - "React.FC" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 122 - }, "lifecycle": "start", "initialIsOpen": true } @@ -2051,14 +2375,36 @@ "classes": [], "functions": [ { + "parentPluginId": "dashboard", "id": "def-server.findByValueEmbeddables", "type": "Function", + "tags": [], + "label": "findByValueEmbeddables", + "description": [], + "signature": [ + "(savedObjectClient: Pick, \"find\">, embeddableType: string) => Promise<{ [key: string]: unknown; }[]>" + ], + "source": { + "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-server.findByValueEmbeddables.$1", "type": "Object", + "tags": [], "label": "savedObjectClient", - "isRequired": true, + "description": [], "signature": [ "Pick, \"find\">" ], - "description": [], "source": { "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-server.findByValueEmbeddables.$2", "type": "string", + "tags": [], "label": "embeddableType", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(savedObjectClient: Pick, \"find\">, embeddableType: string) => Promise<{ [key: string]: unknown; }[]>" - ], - "description": [], - "label": "findByValueEmbeddables", - "source": { - "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", - "lineNumber": 12 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } @@ -2118,30 +2450,34 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "dashboard", "id": "def-server.DashboardPluginSetup", "type": "Interface", + "tags": [], "label": "DashboardPluginSetup", "description": [], - "tags": [], - "children": [], "source": { "path": "src/plugins/dashboard/server/types.ts", "lineNumber": 10 }, + "deprecated": false, + "children": [], "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "dashboard", "id": "def-server.DashboardPluginStart", "type": "Interface", + "tags": [], "label": "DashboardPluginStart", "description": [], - "tags": [], - "children": [], "source": { "path": "src/plugins/dashboard/server/types.ts", "lineNumber": 12 }, + "deprecated": false, + "children": [], "lifecycle": "start", "initialIsOpen": true } @@ -2150,9 +2486,12 @@ "classes": [], "functions": [ { + "parentPluginId": "dashboard", "id": "def-common.migratePanelsTo730", "type": "Function", + "tags": [], "label": "migratePanelsTo730", + "description": [], "signature": [ "(panels: (", "RawSavedDashboardPanelTo60", @@ -2171,13 +2510,19 @@ "text": "SavedDashboardPanelTo60" } ], - "description": [], + "source": { + "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", + "lineNumber": 261 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-common.migratePanelsTo730.$1", "type": "Array", + "tags": [], "label": "panels", - "isRequired": true, + "description": [], "signature": [ "(", "RawSavedDashboardPanelTo60", @@ -2196,298 +2541,395 @@ "text": "SavedDashboardPanelTo60" } ], - "description": [], "source": { "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", "lineNumber": 262 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-common.migratePanelsTo730.$2", "type": "string", + "tags": [], "label": "version", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", "lineNumber": 274 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-common.migratePanelsTo730.$3", "type": "boolean", + "tags": [], "label": "useMargins", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", "lineNumber": 275 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboard", "id": "def-common.migratePanelsTo730.$4.uiState", "type": "Object", - "label": "uiState", "tags": [], + "label": "uiState", "description": [], + "source": { + "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", + "lineNumber": 276 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboard", "id": "def-common.migratePanelsTo730.$4.uiState.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", "lineNumber": 276 }, - "signature": [ - "any" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", - "lineNumber": 276 - } + ] } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", - "lineNumber": 261 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "dashboard", + "id": "def-common.DashboardContainerStateWithType", + "type": "Interface", + "tags": [], + "label": "DashboardContainerStateWithType", + "description": [], + "signature": [ + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.DashboardContainerStateWithType", + "text": "DashboardContainerStateWithType" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + } + ], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 91 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "dashboard", + "id": "def-common.DashboardContainerStateWithType.panels", + "type": "Object", + "tags": [], + "label": "panels", + "description": [], + "signature": [ + "{ [panelId: string]: ", + "DashboardPanelState", + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + " & { [k: string]: unknown; }>; }" + ], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 92 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dashboard", "id": "def-common.GridData", "type": "Interface", + "tags": [], "label": "GridData", "description": [], - "tags": [], + "source": { + "path": "src/plugins/dashboard/common/embeddable/types.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-common.GridData.w", "type": "number", + "tags": [], "label": "w", "description": [], "source": { "path": "src/plugins/dashboard/common/embeddable/types.ts", "lineNumber": 10 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-common.GridData.h", "type": "number", + "tags": [], "label": "h", "description": [], "source": { "path": "src/plugins/dashboard/common/embeddable/types.ts", "lineNumber": 11 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-common.GridData.x", "type": "number", + "tags": [], "label": "x", "description": [], "source": { "path": "src/plugins/dashboard/common/embeddable/types.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-common.GridData.y", "type": "number", + "tags": [], "label": "y", "description": [], "source": { "path": "src/plugins/dashboard/common/embeddable/types.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-common.GridData.i", "type": "string", + "tags": [], "label": "i", "description": [], "source": { "path": "src/plugins/dashboard/common/embeddable/types.ts", "lineNumber": 14 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/common/embeddable/types.ts", - "lineNumber": 9 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "dashboard", "id": "def-common.DashboardDoc700To720", "type": "Type", - "label": "DashboardDoc700To720", "tags": [], + "label": "DashboardDoc700To720", "description": [], + "signature": [ + "Doc" + ], "source": { "path": "src/plugins/dashboard/common/bwc/types.ts", "lineNumber": 55 }, - "signature": [ - "Doc" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.DashboardDoc730ToLatest", "type": "Type", - "label": "DashboardDoc730ToLatest", "tags": [], + "label": "DashboardDoc730ToLatest", "description": [], + "signature": [ + "Doc" + ], "source": { "path": "src/plugins/dashboard/common/bwc/types.ts", "lineNumber": 53 }, - "signature": [ - "Doc" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.DashboardDocPre700", "type": "Type", - "label": "DashboardDocPre700", "tags": [], + "label": "DashboardDocPre700", "description": [], + "signature": [ + "DocPre700" + ], "source": { "path": "src/plugins/dashboard/common/bwc/types.ts", "lineNumber": 57 }, - "signature": [ - "DocPre700" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.RawSavedDashboardPanel730ToLatest", "type": "Type", - "label": "RawSavedDashboardPanel730ToLatest", "tags": [], + "label": "RawSavedDashboardPanel730ToLatest", "description": [], + "signature": [ + "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; panelRefName?: string | undefined; }" + ], "source": { "path": "src/plugins/dashboard/common/bwc/types.ts", "lineNumber": 70 }, - "signature": [ - "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel610", "type": "Type", - "label": "SavedDashboardPanel610", "tags": [], + "label": "SavedDashboardPanel610", "description": [], - "source": { - "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 59 - }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" ], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 64 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel620", "type": "Type", - "label": "SavedDashboardPanel620", "tags": [], + "label": "SavedDashboardPanel620", "description": [], - "source": { - "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 51 - }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" ], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 56 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel630", "type": "Type", - "label": "SavedDashboardPanel630", "tags": [], + "label": "SavedDashboardPanel630", "description": [], - "source": { - "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 43 - }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" ], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 48 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel640To720", "type": "Type", - "label": "SavedDashboardPanel640To720", "tags": [], + "label": "SavedDashboardPanel640To720", "description": [], - "source": { - "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 35 - }, "signature": [ "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" ], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 40 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel730ToLatest", "type": "Type", - "label": "SavedDashboardPanel730ToLatest", "tags": [], + "label": "SavedDashboardPanel730ToLatest", "description": [], + "signature": [ + "Pick & { readonly id?: string | undefined; readonly type: string; }" + ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 76 + "lineNumber": 81 }, - "signature": [ - "Pick & { readonly id?: string | undefined; readonly type: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanelTo60", "type": "Type", - "label": "SavedDashboardPanelTo60", "tags": [], + "label": "SavedDashboardPanelTo60", "description": [], - "source": { - "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 67 - }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" ], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 72 + }, + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/dashboard_enhanced.json b/api_docs/dashboard_enhanced.json index fc41872fc4dc6..31e8f7dcc4997 100644 --- a/api_docs/dashboard_enhanced.json +++ b/api_docs/dashboard_enhanced.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown", "type": "Class", "tags": [], @@ -42,21 +43,35 @@ }, ">" ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.Unnamed.$1", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "dashboardEnhanced", @@ -66,49 +81,52 @@ "text": "Params" } ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", - "lineNumber": 36 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 38 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.supportedTriggers", "type": "Function", + "tags": [], "label": "supportedTriggers", "description": [], + "signature": [ + "() => string[]" + ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 40 }, - "signature": [ - "() => string[]" - ] + "deprecated": false }, { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.getURL", "type": "Function", + "tags": [], "label": "getURL", + "description": [], "signature": [ "(config: ", { @@ -128,13 +146,19 @@ }, ">" ], - "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.getURL.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "dashboardEnhanced", @@ -144,88 +168,90 @@ "text": "DrilldownConfig" } ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.getURL.$2", "type": "Uncategorized", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ "Context" ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", - "lineNumber": 42 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.order", "type": "number", + "tags": [], "label": "order", "description": [], + "signature": [ + "100" + ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 44 }, - "signature": [ - "100" - ] + "deprecated": false }, { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.getDisplayName", "type": "Function", - "children": [], + "tags": [], + "label": "getDisplayName", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getDisplayName", "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 46 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.euiIcon", "type": "string", + "tags": [], "label": "euiIcon", "description": [], + "signature": [ + "\"dashboardApp\"" + ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 48 }, - "signature": [ - "\"dashboardApp\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.CollectConfig", "type": "Function", + "tags": [], "label": "CollectConfig", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", - "lineNumber": 54 - }, "signature": [ { "pluginId": "kibanaUtils", @@ -259,33 +285,69 @@ "text": "BaseActionFactoryContext" }, ">>" - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 54 + }, + "deprecated": false }, { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.createConfig", "type": "Function", - "children": [], + "tags": [], + "label": "createConfig", + "description": [], "signature": [ "() => { dashboardId: string; useCurrentFilters: boolean; useCurrentDateRange: boolean; }" ], - "description": [], - "label": "createConfig", "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 56 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.isConfigValid", "type": "Function", + "tags": [], + "label": "isConfigValid", + "description": [], + "signature": [ + "(config: ", + { + "pluginId": "dashboardEnhanced", + "scope": "common", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-common.DrilldownConfig", + "text": "DrilldownConfig" + }, + ") => config is ", + { + "pluginId": "dashboardEnhanced", + "scope": "common", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-common.DrilldownConfig", + "text": "DrilldownConfig" + } + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.isConfigValid.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "dashboardEnhanced", @@ -295,13 +357,23 @@ "text": "DrilldownConfig" } ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 62 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "dashboardEnhanced", + "id": "def-public.AbstractDashboardDrilldown.getHref", + "type": "Function", + "tags": [], + "label": "getHref", + "description": [], "signature": [ "(config: ", { @@ -311,33 +383,21 @@ "section": "def-common.DrilldownConfig", "text": "DrilldownConfig" }, - ") => config is ", - { - "pluginId": "dashboardEnhanced", - "scope": "common", - "docId": "kibDashboardEnhancedPluginApi", - "section": "def-common.DrilldownConfig", - "text": "DrilldownConfig" - } + ", context: Context) => Promise" ], - "description": [], - "label": "isConfigValid", "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", - "lineNumber": 62 + "lineNumber": 67 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.AbstractDashboardDrilldown.getHref", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.getHref.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "dashboardEnhanced", @@ -347,27 +407,40 @@ "text": "DrilldownConfig" } ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 67 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.getHref.$2", "type": "Uncategorized", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ "Context" ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 67 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "dashboardEnhanced", + "id": "def-public.AbstractDashboardDrilldown.execute", + "type": "Function", + "tags": [], + "label": "execute", + "description": [], "signature": [ "(config: ", { @@ -377,26 +450,21 @@ "section": "def-common.DrilldownConfig", "text": "DrilldownConfig" }, - ", context: Context) => Promise" + ", context: Context) => Promise" ], - "description": [], - "label": "getHref", "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", - "lineNumber": 67 + "lineNumber": 72 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.AbstractDashboardDrilldown.execute", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.execute.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "dashboardEnhanced", @@ -406,57 +474,40 @@ "text": "DrilldownConfig" } ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 72 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.execute.$2", "type": "Uncategorized", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ "Context" ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 72 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(config: ", - { - "pluginId": "dashboardEnhanced", - "scope": "common", - "docId": "kibDashboardEnhancedPluginApi", - "section": "def-common.DrilldownConfig", - "text": "DrilldownConfig" - }, - ", context: Context) => Promise" - ], - "description": [], - "label": "execute", - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", - "lineNumber": 72 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "dashboardEnhanced", "id": "def-public.AbstractDashboardDrilldown.urlGenerator", "type": "Object", - "label": "urlGenerator", "tags": [], + "label": "urlGenerator", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", - "lineNumber": 77 - }, "signature": [ { "pluginId": "dashboard", @@ -465,35 +516,39 @@ "section": "def-public.DashboardUrlGenerator", "text": "DashboardUrlGenerator" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 77 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", - "lineNumber": 34 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-public.Params", "type": "Interface", + "tags": [], "label": "Params", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.Params.start", "type": "Function", + "tags": [], "label": "start", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", - "lineNumber": 27 - }, "signature": [ { "pluginId": "kibanaUtils", @@ -534,32 +589,36 @@ "section": "def-public.CoreStart", "text": "CoreStart" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 27 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "dashboardEnhanced", "id": "def-public.SetupDependencies", "type": "Interface", + "tags": [], "label": "SetupDependencies", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.SetupDependencies.uiActionsEnhanced", "type": "Object", + "tags": [], "label": "uiActionsEnhanced", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", - "lineNumber": 17 - }, "signature": [ { "pluginId": "uiActionsEnhanced", @@ -568,18 +627,20 @@ "section": "def-public.SetupContract", "text": "SetupContract" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.SetupDependencies.embeddable", "type": "Object", + "tags": [], "label": "embeddable", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "embeddable", @@ -588,18 +649,20 @@ "section": "def-public.EmbeddableSetup", "text": "EmbeddableSetup" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.SetupDependencies.share", "type": "CompoundType", + "tags": [], "label": "share", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "share", @@ -608,32 +671,36 @@ "section": "def-public.SharePluginSetup", "text": "SharePluginSetup" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 19 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "dashboardEnhanced", "id": "def-public.StartDependencies", "type": "Interface", + "tags": [], "label": "StartDependencies", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.StartDependencies.uiActionsEnhanced", "type": "Object", + "tags": [], "label": "uiActionsEnhanced", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", - "lineNumber": 23 - }, "signature": [ { "pluginId": "uiActionsEnhanced", @@ -642,18 +709,20 @@ "section": "def-public.StartContract", "text": "StartContract" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 23 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.StartDependencies.data", "type": "Object", + "tags": [], "label": "data", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", - "lineNumber": 24 - }, "signature": [ { "pluginId": "data", @@ -662,18 +731,20 @@ "section": "def-public.DataPublicPluginStart", "text": "DataPublicPluginStart" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 24 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.StartDependencies.embeddable", "type": "Object", + "tags": [], "label": "embeddable", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", - "lineNumber": 25 - }, "signature": [ { "pluginId": "embeddable", @@ -682,18 +753,20 @@ "section": "def-public.EmbeddableStart", "text": "EmbeddableStart" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 25 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.StartDependencies.share", "type": "CompoundType", + "tags": [], "label": "share", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", - "lineNumber": 26 - }, "signature": [ { "pluginId": "share", @@ -702,18 +775,20 @@ "section": "def-public.SharePluginStart", "text": "SharePluginStart" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 26 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-public.StartDependencies.dashboard", "type": "Object", + "tags": [], "label": "dashboard", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", - "lineNumber": 27 - }, "signature": [ { "pluginId": "dashboard", @@ -722,60 +797,67 @@ "section": "def-public.DashboardStart", "text": "DashboardStart" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 27 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", - "lineNumber": 22 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-public.Config", "type": "Type", - "label": "Config", "tags": [], + "label": "Config", "description": [], + "signature": [ + "{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }" + ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/types.ts", "lineNumber": 11 }, - "signature": [ - "{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "dashboardEnhanced", "id": "def-public.SetupContract", "type": "Interface", + "tags": [], "label": "SetupContract", "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", "lineNumber": 31 }, + "deprecated": false, + "children": [], "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "dashboardEnhanced", "id": "def-public.StartContract", "type": "Interface", + "tags": [], "label": "StartContract", "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", "lineNumber": 34 }, + "deprecated": false, + "children": [], "lifecycle": "start", "initialIsOpen": true } @@ -785,22 +867,25 @@ "functions": [], "interfaces": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-server.SetupDependencies", "type": "Interface", + "tags": [], "label": "SetupDependencies", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-server.SetupDependencies.uiActionsEnhanced", "type": "Object", + "tags": [], "label": "uiActionsEnhanced", "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", - "lineNumber": 13 - }, "signature": [ { "pluginId": "uiActionsEnhanced", @@ -809,41 +894,46 @@ "section": "def-server.SetupContract", "text": "SetupContract" } - ] + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", + "lineNumber": 13 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "dashboardEnhanced", "id": "def-server.StartDependencies", "type": "Interface", + "tags": [], "label": "StartDependencies", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-server.StartDependencies.uiActionsEnhanced", "type": "Uncategorized", + "tags": [], "label": "uiActionsEnhanced", "description": [], + "signature": [ + "void" + ], "source": { "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", "lineNumber": 17 }, - "signature": [ - "void" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", - "lineNumber": 16 - }, "initialIsOpen": false } ], @@ -851,30 +941,34 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "dashboardEnhanced", "id": "def-server.SetupContract", "type": "Interface", + "tags": [], "label": "SetupContract", "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", "lineNumber": 21 }, + "deprecated": false, + "children": [], "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "dashboardEnhanced", "id": "def-server.StartContract", "type": "Interface", + "tags": [], "label": "StartContract", "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", "lineNumber": 24 }, + "deprecated": false, + "children": [], "lifecycle": "start", "initialIsOpen": true } @@ -883,34 +977,12 @@ "classes": [], "functions": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-common.createExtract", "type": "Function", - "children": [ - { - "id": "def-common.createExtract.$1.drilldownId", - "type": "Object", - "label": "{\n drilldownId,\n}", - "tags": [], - "description": [], - "children": [ - { - "tags": [], - "id": "def-common.createExtract.$1.drilldownId.drilldownId", - "type": "string", - "label": "drilldownId", - "description": [], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", - "lineNumber": 49 - } - } - ], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", - "lineNumber": 48 - } - } - ], + "tags": [], + "label": "createExtract", + "description": [], "signature": [ "({ drilldownId, }: { drilldownId: string; }) => (state: ", { @@ -932,45 +1004,51 @@ "SavedObjectReference", "[]; }" ], - "description": [], - "label": "createExtract", "source": { "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", "lineNumber": 46 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.createInject", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.createInject.$1.drilldownId", + "parentPluginId": "dashboardEnhanced", + "id": "def-common.createExtract.$1.drilldownId", "type": "Object", - "label": "{\n drilldownId,\n}", "tags": [], + "label": "{\n drilldownId,\n}", "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-common.createInject.$1.drilldownId.drilldownId", + "parentPluginId": "dashboardEnhanced", + "id": "def-common.createExtract.$1.drilldownId.drilldownId", "type": "string", + "tags": [], "label": "drilldownId", "description": [], "source": { "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", - "lineNumber": 34 - } + "lineNumber": 49 + }, + "deprecated": false } - ], - "source": { - "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", - "lineNumber": 33 - } + ] } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "dashboardEnhanced", + "id": "def-common.createInject", + "type": "Function", + "tags": [], + "label": "createInject", + "description": [], "signature": [ "({ drilldownId, }: { drilldownId: string; }) => (state: ", { @@ -991,13 +1069,41 @@ "text": "SerializedEvent" } ], - "description": [], - "label": "createInject", "source": { "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", "lineNumber": 31 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "dashboardEnhanced", + "id": "def-common.createInject.$1.drilldownId", + "type": "Object", + "tags": [], + "label": "{\n drilldownId,\n}", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", + "lineNumber": 33 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "dashboardEnhanced", + "id": "def-common.createInject.$1.drilldownId.drilldownId", + "type": "string", + "tags": [], + "label": "drilldownId", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", + "lineNumber": 34 + }, + "deprecated": false + } + ] + } + ], "returnComment": [], "initialIsOpen": false } @@ -1006,35 +1112,39 @@ "enums": [], "misc": [ { + "parentPluginId": "dashboardEnhanced", "id": "def-common.DrilldownConfig", "type": "Type", - "label": "DrilldownConfig", "tags": [], + "label": "DrilldownConfig", "description": [], + "signature": [ + "{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }" + ], "source": { "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/types.ts", "lineNumber": 9 }, - "signature": [ - "{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "dashboardEnhanced", "id": "def-common.EMBEDDABLE_TO_DASHBOARD_DRILLDOWN", "type": "string", + "tags": [], "label": "EMBEDDABLE_TO_DASHBOARD_DRILLDOWN", "description": [ "\nNOTE: DO NOT CHANGE THIS STRING WITHOUT CAREFUL CONSIDERATOIN, BECAUSE IT IS\nSTORED IN SAVED OBJECTS.\n\nAlso temporary dashboard drilldown migration code inside embeddable plugin relies on it\nx-pack/plugins/embeddable_enhanced/public/embeddables/embeddable_action_storage.ts" ], + "signature": [ + "\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\"" + ], "source": { "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/constants.ts", "lineNumber": 15 }, - "signature": [ - "\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\"" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/dashboard_mode.json b/api_docs/dashboard_mode.json index 1ad7905f9a65a..1239771f5c991 100644 --- a/api_docs/dashboard_mode.json +++ b/api_docs/dashboard_mode.json @@ -11,6 +11,7 @@ "server": { "classes": [ { + "parentPluginId": "dashboardMode", "id": "def-server.DashboardModeServerPlugin", "type": "Class", "tags": [], @@ -34,21 +35,35 @@ }, "" ], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboardMode", "id": "def-server.DashboardModeServerPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboardMode", "id": "def-server.DashboardModeServerPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -59,24 +74,23 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", - "lineNumber": 30 - } + "returnComment": [] }, { + "parentPluginId": "dashboardMode", "id": "def-server.DashboardModeServerPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -88,13 +102,19 @@ }, ", { security }: DashboardModeServerSetupDependencies) => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboardMode", "id": "def-server.DashboardModeServerPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -105,38 +125,40 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dashboardMode", "id": "def-server.DashboardModeServerPlugin.setup.$2", "type": "Object", + "tags": [], "label": "{ security }", - "isRequired": true, + "description": [], "signature": [ "DashboardModeServerSetupDependencies" ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", - "lineNumber": 34 - } + "returnComment": [] }, { + "parentPluginId": "dashboardMode", "id": "def-server.DashboardModeServerPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -148,13 +170,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dashboardMode", "id": "def-server.DashboardModeServerPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -164,41 +192,35 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", - "lineNumber": 60 - } + "returnComment": [] }, { + "parentPluginId": "dashboardMode", "id": "def-server.DashboardModeServerPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", "lineNumber": 62 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", - "lineNumber": 26 - }, "initialIsOpen": false } ], @@ -216,28 +238,32 @@ "misc": [], "objects": [ { + "parentPluginId": "dashboardMode", "id": "def-common.UI_SETTINGS", "type": "Object", "tags": [], + "label": "UI_SETTINGS", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/common/constants.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboardMode", "id": "def-common.UI_SETTINGS.CONFIG_DASHBOARD_ONLY_MODE_ROLES", "type": "string", + "tags": [], "label": "CONFIG_DASHBOARD_ONLY_MODE_ROLES", "description": [], "source": { "path": "x-pack/plugins/dashboard_mode/common/constants.ts", "lineNumber": 9 - } + }, + "deprecated": false } ], - "description": [], - "label": "UI_SETTINGS", - "source": { - "path": "x-pack/plugins/dashboard_mode/common/constants.ts", - "lineNumber": 8 - }, "initialIsOpen": false } ] diff --git a/api_docs/data.json b/api_docs/data.json index 629e2aee35eb9..838f956520ff8 100644 --- a/api_docs/data.json +++ b/api_docs/data.json @@ -3,16 +3,29 @@ "client": { "classes": [ { + "parentPluginId": "data", "id": "def-public.AggConfig", "type": "Class", "tags": [], "label": "AggConfig", "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.ensureIds", "type": "Function", + "tags": [ + "return" + ], "label": "ensureIds", + "description": [ + "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" + ], "signature": [ "typeof ", { @@ -24,42 +37,47 @@ }, ".ensureIds" ], - "description": [ - "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.ensureIds.$1", "type": "Array", + "tags": [], "label": "list", - "isRequired": true, - "signature": [ - "any[]" - ], "description": [ "- a list of objects, objects can be anything really" ], + "signature": [ + "any[]" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 63 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "- the list that was passed in" - ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 63 - } + ] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.nextId", "type": "Function", + "tags": [ + "return" + ], "label": "nextId", + "description": [ + "\nCalculate the next id based on the ids in this list\n" + ], "signature": [ "typeof ", { @@ -71,15 +89,19 @@ }, ".nextId" ], - "description": [ - "\nCalculate the next id based on the ids in this list\n" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.nextId.$1", "type": "Array", + "tags": [], "label": "list", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -90,34 +112,25 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "list - a list of objects with id properties" - ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 83 - } + ] }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfig.aggConfigs", "type": "Object", + "tags": [], "label": "aggConfigs", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 92 - }, "signature": [ { "pluginId": "data", @@ -126,54 +139,62 @@ "section": "def-common.AggConfigs", "text": "AggConfigs" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 92 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfig.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 93 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfig.enabled", "type": "boolean", + "tags": [], "label": "enabled", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 94 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfig.params", "type": "Any", + "tags": [], "label": "params", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 95 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfig.parent", "type": "Object", + "tags": [], "label": "parent", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 96 - }, "signature": [ { "pluginId": "data", @@ -183,50 +204,68 @@ "text": "AggConfigs" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 96 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfig.brandNew", "type": "CompoundType", + "tags": [], "label": "brandNew", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 97 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfig.schema", "type": "string", + "tags": [], "label": "schema", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 98 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.AggConfig.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.Unnamed.$1", "type": "Object", + "tags": [], "label": "aggConfigs", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -236,17 +275,20 @@ "text": "AggConfigs" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 104 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.AggConfig.Unnamed.$2", "type": "Object", + "tags": [], "label": "opts", - "isRequired": true, + "description": [], "signature": [ "Pick, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 104 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 104 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.setParams", "type": "Function", - "label": "setParams", - "signature": [ - "(from: any) => void" + "tags": [ + "return" ], + "label": "setParams", "description": [ "\nWrite the current values to this.params, filling in the defaults as we go\n" ], + "signature": [ + "(from: any) => void" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 134 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.setParams.$1", "type": "Any", + "tags": [], "label": "from", - "isRequired": true, - "signature": [ - "any" - ], "description": [ "- optional object to read values from,\n used when initializing" ], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 134 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 134 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getParam", "type": "Function", + "tags": [], "label": "getParam", + "description": [], "signature": [ "(key: string) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 171 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.getParam.$1", "type": "string", + "tags": [], "label": "key", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 171 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 171 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.write", "type": "Function", + "tags": [], "label": "write", + "description": [], "signature": [ "(aggs?: ", { @@ -365,13 +416,19 @@ }, " | undefined) => Record" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 175 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.write.$1", "type": "Object", + "tags": [], "label": "aggs", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -382,85 +439,98 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 175 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 175 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.isFilterable", "type": "Function", + "tags": [], "label": "isFilterable", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 179 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.createFilter", "type": "Function", + "tags": [], "label": "createFilter", + "description": [], "signature": [ "(key: string, params?: {}) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.createFilter.$1", "type": "string", + "tags": [], "label": "key", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 183 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.AggConfig.createFilter.$2", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "{}" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 183 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 183 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.onSearchRequestStart", "type": "Function", + "tags": [ + "return" + ], "label": "onSearchRequestStart", + "description": [ + "\n Hook for pre-flight logic, see AggType#onSearchRequestStart" + ], "signature": [ "(searchSource: Pick<", { @@ -480,15 +550,19 @@ }, " | undefined) => Promise | Promise" ], - "description": [ - "\n Hook for pre-flight logic, see AggType#onSearchRequestStart" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 209 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.onSearchRequestStart.$1", "type": "Object", + "tags": [], "label": "searchSource", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -500,17 +574,20 @@ }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 209 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.AggConfig.onSearchRequestStart.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -521,26 +598,27 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 209 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 209 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.toDsl", "type": "Function", + "tags": [ + "return" + ], "label": "toDsl", + "description": [ + "\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n" + ], "signature": [ "(aggConfigs?: ", { @@ -552,15 +630,21 @@ }, " | undefined) => any" ], - "description": [ - "\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 230 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.toDsl.$1", "type": "Object", + "tags": [], "label": "aggConfigs", - "isRequired": false, + "description": [ + "- the config object to convert" + ], "signature": [ { "pluginId": "data", @@ -571,90 +655,98 @@ }, " | undefined" ], - "description": [ - "- the config object to convert" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 230 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return" - ], "returnComment": [ "- if the config has a dsl representation, it is\n returned, else undefined is returned" - ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 230 - } + ] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.serialize", "type": "Function", + "tags": [], "label": "serialize", + "description": [], "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [ - "Returns a serialized representation of an AggConfig." - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 265 - } + }, + "deprecated": false, + "children": [], + "returnComment": [ + "Returns a serialized representation of an AggConfig." + ] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.toJSON", "type": "Function", + "tags": [ + "deprecated" + ], "label": "toJSON", + "description": [], "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; }" ], - "description": [], - "children": [], - "tags": [ - "deprecated" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 296 - } + }, + "deprecated": true, + "references": [ + { + "plugin": "visualizations", + "link": { + "path": "src/plugins/visualizations/public/vis.ts", + "lineNumber": 172 + } + } + ], + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.toSerializedFieldFormat", "type": "Function", + "tags": [], "label": "toSerializedFieldFormat", - "signature": [ - "() => {}" - ], "description": [ "\nReturns a serialized field format for the field used in this agg.\nThis can be passed to fieldFormats.deserialize to get the field\nformat instance.\n" ], - "children": [], - "tags": [ - "public" + "signature": [ + "() => {}" ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 307 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.toExpressionAst", "type": "Function", + "tags": [], "label": "toExpressionAst", + "description": [], "signature": [ "() => ", { @@ -666,21 +758,23 @@ }, " | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [ - "Returns an ExpressionAst representing the this agg type." - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 316 - } + }, + "deprecated": false, + "children": [], + "returnComment": [ + "Returns an ExpressionAst representing the this agg type." + ] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getAggParams", "type": "Function", + "tags": [], "label": "getAggParams", + "description": [], "signature": [ "() => ", { @@ -700,19 +794,21 @@ }, ">[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 371 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getRequestAggs", "type": "Function", + "tags": [], "label": "getRequestAggs", + "description": [], "signature": [ "() => ", { @@ -724,19 +820,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 375 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getResponseAggs", "type": "Function", + "tags": [], "label": "getResponseAggs", + "description": [], "signature": [ "() => ", { @@ -748,176 +846,202 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 379 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getValue", "type": "Function", + "tags": [], "label": "getValue", + "description": [], "signature": [ "(bucket: any) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 383 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.getValue.$1", "type": "Any", + "tags": [], "label": "bucket", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 383 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 383 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getKey", "type": "Function", + "tags": [], "label": "getKey", + "description": [], "signature": [ "(bucket: any, key?: string | undefined) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 387 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.getKey.$1", "type": "Any", + "tags": [], "label": "bucket", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 387 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getKey.$2", "type": "string", + "tags": [], "label": "key", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 387 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 387 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getFieldDisplayName", "type": "Function", + "tags": [], "label": "getFieldDisplayName", + "description": [], "signature": [ "() => any" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 395 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getField", "type": "Function", + "tags": [], "label": "getField", + "description": [], "signature": [ "() => any" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 401 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getValueBucketPath", "type": "Function", + "tags": [], "label": "getValueBucketPath", - "signature": [ - "() => string" - ], "description": [ "\nReturns the bucket path containing the main value the agg will produce\n(e.g. for sum of bytes it will point to the sum, for median it will point\n to the 50 percentile in the percentile multi value bucket)" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 410 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.makeLabel", "type": "Function", + "tags": [], "label": "makeLabel", + "description": [], "signature": [ "(percentageMode?: boolean) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 414 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.makeLabel.$1", "type": "boolean", + "tags": [], "label": "percentageMode", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 414 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 414 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getIndexPattern", "type": "Function", + "tags": [], "label": "getIndexPattern", + "description": [], "signature": [ "() => ", { @@ -928,19 +1052,21 @@ "text": "IndexPattern" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 428 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.getTimeRange", "type": "Function", + "tags": [], "label": "getTimeRange", + "description": [], "signature": [ "() => ", { @@ -952,57 +1078,57 @@ }, " | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 432 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.fieldName", "type": "Function", + "tags": [], "label": "fieldName", + "description": [], "signature": [ "() => any" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 436 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.fieldIsTimeField", "type": "Function", + "tags": [], "label": "fieldIsTimeField", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 441 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfig.type", "type": "Object", - "label": "type", "tags": [], + "label": "type", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 452 - }, "signature": [ { "pluginId": "data", @@ -1011,18 +1137,20 @@ "section": "def-common.IAggType", "text": "IAggType" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 452 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.AggConfig.type", "type": "Object", - "label": "type", "tags": [], + "label": "type", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 456 - }, "signature": [ { "pluginId": "data", @@ -1031,12 +1159,20 @@ "section": "def-common.IAggType", "text": "IAggType" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 456 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.AggConfig.setType", "type": "Function", + "tags": [], "label": "setType", + "description": [], "signature": [ "(type: ", { @@ -1048,13 +1184,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 486 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfig.setType.$1", "type": "Object", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1064,44 +1206,39 @@ "text": "IAggType" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 486 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 486 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 55 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.AggConfigs", "type": "Class", "tags": [], "label": "AggConfigs", "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfigs.indexPattern", "type": "Object", + "tags": [], "label": "indexPattern", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 65 - }, "signature": [ { "pluginId": "data", @@ -1110,18 +1247,20 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 66 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfigs.timeRange", "type": "Object", + "tags": [], "label": "timeRange", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 66 - }, "signature": [ { "pluginId": "data", @@ -1131,32 +1270,52 @@ "text": "TimeRange" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 67 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfigs.timeFields", "type": "Array", + "tags": [], "label": "timeFields", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 67 + "lineNumber": 68 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-public.AggConfigs.hierarchical", + "type": "CompoundType", "tags": [], - "id": "def-public.AggConfigs.aggs", - "type": "Array", - "label": "aggs", + "label": "hierarchical", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 70 + "lineNumber": 69 }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.aggs", + "type": "Array", + "tags": [], + "label": "aggs", + "description": [], "signature": [ { "pluginId": "data", @@ -1166,22 +1325,36 @@ "text": "AggConfig" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 73 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 75 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.Unnamed.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1191,17 +1364,20 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 73 - } + "lineNumber": 76 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.Unnamed.$2", "type": "Array", + "tags": [], "label": "configStates", - "isRequired": true, + "description": [], "signature": [ "Pick, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 74 - } + "lineNumber": 77 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.Unnamed.$3", "type": "Object", + "tags": [], "label": "opts", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1243,55 +1422,59 @@ "text": "AggConfigsOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 75 - } + "lineNumber": 78 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 72 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.setTimeFields", "type": "Function", + "tags": [], "label": "setTimeFields", + "description": [], "signature": [ "(timeFields: string[] | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 91 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.setTimeFields.$1", "type": "Array", + "tags": [], "label": "timeFields", - "isRequired": false, + "description": [], "signature": [ "string[] | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 87 - } + "lineNumber": 91 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 87 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.setTimeRange", "type": "Function", + "tags": [], "label": "setTimeRange", + "description": [], "signature": [ "(timeRange: ", { @@ -1303,13 +1486,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 95 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.setTimeRange.$1", "type": "Object", + "tags": [], "label": "timeRange", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1319,24 +1508,23 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 - } + "lineNumber": 95 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.clone", "type": "Function", + "tags": [], "label": "clone", + "description": [], "signature": [ "({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ", { @@ -1347,39 +1535,88 @@ "text": "AggConfigs" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 113 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.clone.$1", "type": "Object", + "tags": [], "label": "{ enabledOnly = true }", - "isRequired": true, + "description": [], "signature": [ "{ enabledOnly?: boolean | undefined; }" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 109 - } + "lineNumber": 113 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 109 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.createAggConfig", "type": "Function", + "tags": [], + "label": "createAggConfig", + "description": [], + "signature": [ + "(params: Pick & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 126 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.createAggConfig.$1", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "Pick, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 123 - } + "lineNumber": 127 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.createAggConfig.$2", "type": "Object", + "tags": [], "label": "{ addToAggConfigs = true }", - "isRequired": true, + "description": [], "signature": [ "{ addToAggConfigs?: boolean | undefined; }" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 124 - } + "lineNumber": 128 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.jsonDataEquals", + "type": "Function", + "tags": [], + "label": "jsonDataEquals", + "description": [ + "\nData-by-data comparison of this Aggregation\nIgnores the non-array indexes" + ], "signature": [ - "(params: Pick & Pick<{ type: string | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - }, - "; }, \"type\"> & Pick<{ type: string | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - } + "[]) => boolean" ], - "description": [], - "label": "createAggConfig", "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 122 + "lineNumber": 169 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.AggConfigs.jsonDataEquals", - "type": "Function", - "label": "jsonDataEquals", - "signature": [ - "(aggConfigs: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - "[]) => boolean" - ], - "description": [ - "\nData-by-data comparison of this Aggregation\nIgnores the non-array indexes" - ], + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.jsonDataEquals.$1", "type": "Array", + "tags": [], "label": "aggConfigs", - "isRequired": true, + "description": [ + "an AggConfigs instance" + ], "signature": [ { "pluginId": "data", @@ -1501,57 +1710,41 @@ }, "[]" ], - "description": [ - "an AggConfigs instance" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 165 - } + "lineNumber": 169 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 165 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.toDsl", "type": "Function", + "tags": [], "label": "toDsl", - "signature": [ - "(hierarchical?: boolean) => Record" - ], "description": [], - "children": [ - { - "id": "def-public.AggConfigs.toDsl.$1", - "type": "boolean", - "label": "hierarchical", - "isRequired": true, - "signature": [ - "boolean" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 177 - } - } + "signature": [ + "() => Record" ], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 177 - } + "lineNumber": 181 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.getAll", "type": "Function", + "tags": [], "label": "getAll", + "description": [], "signature": [ "() => ", { @@ -1563,19 +1756,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 246 - } + "lineNumber": 250 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.byIndex", "type": "Function", + "tags": [], "label": "byIndex", + "description": [], "signature": [ "(index: number) => ", { @@ -1586,34 +1781,39 @@ "text": "AggConfig" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 254 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.byIndex.$1", "type": "number", + "tags": [], "label": "index", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 250 - } + "lineNumber": 254 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 250 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.byId", "type": "Function", + "tags": [], "label": "byId", + "description": [], "signature": [ "(id: string) => ", { @@ -1625,34 +1825,39 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 258 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.byId.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 - } + "lineNumber": 258 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.byName", "type": "Function", + "tags": [], "label": "byName", + "description": [], "signature": [ "(name: string) => ", { @@ -1664,34 +1869,39 @@ }, "[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 262 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.byName.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 - } + "lineNumber": 262 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.byType", "type": "Function", + "tags": [], "label": "byType", + "description": [], "signature": [ "(type: string) => ", { @@ -1703,34 +1913,39 @@ }, "[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 266 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.byType.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 - } + "lineNumber": 266 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.byTypeName", "type": "Function", + "tags": [], "label": "byTypeName", + "description": [], "signature": [ "(type: string) => ", { @@ -1742,34 +1957,39 @@ }, "[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 270 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.byTypeName.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 - } + "lineNumber": 270 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.bySchemaName", "type": "Function", + "tags": [], "label": "bySchemaName", + "description": [], "signature": [ "(schema: string) => ", { @@ -1781,34 +2001,39 @@ }, "[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 274 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.bySchemaName.$1", "type": "string", + "tags": [], "label": "schema", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 - } + "lineNumber": 274 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.getRequestAggs", "type": "Function", + "tags": [], "label": "getRequestAggs", + "description": [], "signature": [ "() => ", { @@ -1820,19 +2045,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 274 - } + "lineNumber": 278 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.getRequestAggById", "type": "Function", + "tags": [], "label": "getRequestAggById", + "description": [], "signature": [ "(id: string) => ", { @@ -1844,34 +2071,43 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 292 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.getRequestAggById.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 288 - } + "lineNumber": 292 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 288 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.getResponseAggs", "type": "Function", + "tags": [ + "return" + ], "label": "getResponseAggs", + "description": [ + "\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n" + ], "signature": [ "() => ", { @@ -1883,23 +2119,25 @@ }, "[]" ], - "description": [ - "\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n" - ], - "children": [], - "tags": [ - "return" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 303 - } + "lineNumber": 307 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.getResponseAggById", "type": "Function", + "tags": [ + "return" + ], "label": "getResponseAggById", + "description": [ + "\nFind a response agg by it's id. This may be an agg in the aggConfigs, or one\ncreated specifically for a response value\n" + ], "signature": [ "(id: string) => ", { @@ -1911,40 +2149,41 @@ }, " | undefined" ], - "description": [ - "\nFind a response agg by it's id. This may be an agg in the aggConfigs, or one\ncreated specifically for a response value\n" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 321 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.getResponseAggById.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- the id of the agg to find" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 317 - } + "lineNumber": 321 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 317 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.onSearchRequestStart", "type": "Function", + "tags": [], "label": "onSearchRequestStart", + "description": [], "signature": [ "(searchSource: Pick<", { @@ -1964,13 +2203,19 @@ }, " | undefined) => Promise<[unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 330 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggConfigs.onSearchRequestStart.$1", "type": "Object", + "tags": [], "label": "searchSource", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -1982,17 +2227,20 @@ }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 - } + "lineNumber": 330 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.onSearchRequestStart.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -2003,28 +2251,21 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 - } + "lineNumber": 330 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 64 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.AggParamType", "type": "Class", "tags": [], @@ -2048,76 +2289,87 @@ }, "" ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggParamType.makeAgg", "type": "Function", + "tags": [], "label": "makeAgg", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", - "lineNumber": 15 - }, "signature": [ "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggParamType.allowedAggs", "type": "Array", + "tags": [], "label": "allowedAggs", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 16 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.AggParamType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggParamType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", - "lineNumber": 18 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin", "type": "Class", "tags": [], @@ -2158,21 +2410,35 @@ ", ", "DataSetupDependencies" ], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2183,24 +2449,23 @@ }, "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>" ], - "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 71 - } + "lineNumber": 70 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 71 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -2231,13 +2496,19 @@ "text": "DataPublicPluginSetup" } ], - "description": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 79 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2258,38 +2529,40 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 81 - } + "lineNumber": 80 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.setup.$2", "type": "Object", + "tags": [], "label": "{ bfetch, expressions, uiActions, usageCollection, inspector }", - "isRequired": true, + "description": [], "signature": [ "DataSetupDependencies" ], - "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 82 - } + "lineNumber": 81 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 80 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -2310,13 +2583,19 @@ "text": "DataPublicPluginStart" } ], - "description": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 127 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2326,58 +2605,56 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 131 - } + "lineNumber": 127 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.start.$2", "type": "Object", + "tags": [], "label": "{ uiActions }", - "isRequired": true, + "description": [], "signature": [ "DataStartDependencies" ], - "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 131 - } + "lineNumber": 127 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 131 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 213 - } + "lineNumber": 209 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 55 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.DuplicateIndexPatternError", "type": "Class", "tags": [], @@ -2393,208 +2670,233 @@ }, " extends Error" ], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.DuplicateIndexPatternError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.DuplicateIndexPatternError.Unnamed.$1", "type": "string", + "tags": [], "label": "message", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", "lineNumber": 10 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", - "lineNumber": 10 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.FieldFormat", "type": "Class", "tags": [], "label": "FieldFormat", "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", + "id": "def-public.FieldFormat.id", + "type": "string", "tags": [ "property", - "static", - "public" + "static" ], - "id": "def-public.FieldFormat.id", - "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-public.FieldFormat.title", + "type": "string", "tags": [ "property", - "static", - "public" + "static" ], - "id": "def-public.FieldFormat.title", - "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 38 - } + }, + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-public.FieldFormat.fieldType", + "type": "CompoundType", "tags": [ "property", "private" ], - "id": "def-public.FieldFormat.fieldType", - "type": "CompoundType", "label": "fieldType", "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 44 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-public.FieldFormat.convertObject", + "type": "Object", "tags": [ "property", "private" ], - "id": "def-public.FieldFormat.convertObject", - "type": "Object", "label": "convertObject", "description": [], + "signature": [ + "FieldFormatConvert", + " | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 52 }, - "signature": [ - "FieldFormatConvert", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-public.FieldFormat.htmlConvert", + "type": "Function", "tags": [ "property", "protected" ], - "id": "def-public.FieldFormat.htmlConvert", - "type": "Function", "label": "htmlConvert", "description": [], + "signature": [ + "HtmlContextTypeConvert", + " | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 60 }, - "signature": [ - "HtmlContextTypeConvert", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-public.FieldFormat.textConvert", + "type": "Function", "tags": [ "property", "protected" ], - "id": "def-public.FieldFormat.textConvert", - "type": "Function", "label": "textConvert", "description": [], + "signature": [ + "TextContextTypeConvert", + " | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 68 }, - "signature": [ - "TextContextTypeConvert", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-public.FieldFormat.type", + "type": "Any", "tags": [ "property", "private" ], - "id": "def-public.FieldFormat.type", - "type": "Any", "label": "type", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 74 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.FieldFormat.allowsNumericalAggregations", "type": "CompoundType", + "tags": [], "label": "allowsNumericalAggregations", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 75 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.FieldFormat._params", "type": "Any", + "tags": [], "label": "_params", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 77 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.FieldFormat.getConfig", "type": "Function", + "tags": [], "label": "getConfig", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 78 - }, "signature": [ { "pluginId": "data", @@ -2604,36 +2906,53 @@ "text": "GetConfigFn" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 78 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FieldFormat.Unnamed.$1", "type": "Object", + "tags": [], "label": "_params", - "isRequired": true, + "description": [], "signature": [ "IFieldFormatMetaParams" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 80 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.Unnamed.$2", "type": "Function", + "tags": [], "label": "getConfig", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -2644,24 +2963,27 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 80 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 80 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.convert", "type": "Function", + "tags": [ + "return" + ], "label": "convert", + "description": [ + "\nConvert a raw value to a formatted string" + ], "signature": [ "(value: any, contentType?: ", { @@ -2675,29 +2997,38 @@ "HtmlContextTypeOptions", " | undefined) => string" ], - "description": [ - "\nConvert a raw value to a formatted string" - ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FieldFormat.convert.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 99 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.convert.$2", "type": "CompoundType", + "tags": [], "label": "contentType", - "isRequired": true, + "description": [ + "- optional content type, the only two contentTypes\ncurrently supported are \"html\" and \"text\", which helps\nformatters adjust to different contexts" + ], "signature": [ { "pluginId": "data", @@ -2707,47 +3038,48 @@ "text": "FieldFormatsContentType" } ], - "description": [ - "- optional content type, the only two contentTypes\ncurrently supported are \"html\" and \"text\", which helps\nformatters adjust to different contexts" - ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 100 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.convert.$3", "type": "CompoundType", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ "Record | ", "HtmlContextTypeOptions", " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 101 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return", - "public" - ], "returnComment": [ "- the formatted string, which is assumed to be html, safe for\n injecting into the DOM or a DOM attribute" - ], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 98 - } + ] }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.getConverterFor", "type": "Function", + "tags": [ + "return" + ], "label": "getConverterFor", + "description": [ + "\nGet a convert function that is bound to a specific contentType" + ], "signature": [ "(contentType?: ", { @@ -2760,15 +3092,19 @@ ") => ", "FieldFormatConvertFunction" ], - "description": [ - "\nGet a convert function that is bound to a specific contentType" - ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 118 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FieldFormat.getConverterFor.$1", "type": "CompoundType", + "tags": [], "label": "contentType", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -2778,132 +3114,135 @@ "text": "FieldFormatsContentType" } ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 119 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return", - "public" - ], "returnComment": [ "- a bound converter function" - ], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 118 - } + ] }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.getParamDefaults", "type": "Function", - "label": "getParamDefaults", - "signature": [ - "() => Record" + "tags": [ + "return" ], + "label": "getParamDefaults", "description": [ "\nGet parameter defaults" ], - "children": [], - "tags": [ - "return", - "public" - ], - "returnComment": [ - "- parameter defaults" + "signature": [ + "() => Record" ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 133 - } + }, + "deprecated": false, + "children": [], + "returnComment": [ + "- parameter defaults" + ] }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.param", "type": "Function", - "label": "param", - "signature": [ - "(name: string) => any" + "tags": [ + "return" ], + "label": "param", "description": [ "\nGet the value of a param. This value may be a default value.\n" ], + "signature": [ + "(name: string) => any" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 144 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FieldFormat.param.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- the param name to fetch" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 144 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return", - "public" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 144 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.params", "type": "Function", - "label": "params", - "signature": [ - "() => Record" + "tags": [ + "return" ], + "label": "params", "description": [ "\nGet all of the params in a single object" ], - "children": [], - "tags": [ - "return", - "public" + "signature": [ + "() => Record" ], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 161 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.toJSON", "type": "Function", - "label": "toJSON", - "signature": [ - "() => { id: any; params: any; }" + "tags": [ + "return" ], + "label": "toJSON", "description": [ "\nSerialize this format to a simple POJO, with only the params\nthat are not default\n" ], - "children": [], - "tags": [ - "return", - "public" + "signature": [ + "() => { id: any; params: any; }" ], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 172 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.from", "type": "Function", + "tags": [], "label": "from", + "description": [], "signature": [ "typeof ", { @@ -2915,51 +3254,58 @@ }, ".from" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 193 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FieldFormat.from.$1", "type": "Function", + "tags": [], "label": "convertFn", - "isRequired": true, + "description": [], "signature": [ "FieldFormatConvertFunction" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 193 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 193 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.setupContentType", "type": "Function", + "tags": [], "label": "setupContentType", + "description": [], "signature": [ "() => ", "FieldFormatConvert" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 197 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FieldFormat.isInstanceOfFieldFormat", "type": "Function", + "tags": [], "label": "isInstanceOfFieldFormat", + "description": [], "signature": [ "typeof ", { @@ -2971,38 +3317,37 @@ }, ".isInstanceOfFieldFormat" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 204 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FieldFormat.isInstanceOfFieldFormat.$1", "type": "Any", + "tags": [], "label": "fieldFormat", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 204 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 204 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IndexPattern", "type": "Class", "tags": [], @@ -3025,58 +3370,66 @@ "text": "IIndexPattern" } ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 45 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 46 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.fieldFormatMap", "type": "Object", + "tags": [], "label": "fieldFormatMap", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 47 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.typeMeta", "type": "Object", + "tags": [], "label": "typeMeta", "description": [ "\nOnly used by rollup indices, used by rollup specific endpoint to load field list" ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 51 - }, "signature": [ { "pluginId": "data", @@ -3086,18 +3439,20 @@ "text": "TypeMeta" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.fields", "type": "CompoundType", + "tags": [], "label": "fields", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 52 - }, "signature": [ { "pluginId": "data", @@ -3115,136 +3470,155 @@ "text": "FieldSpec" }, ">; }" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 52 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 53 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-public.IndexPattern.intervalName", + "type": "string", "tags": [ "deprecated" ], - "id": "def-public.IndexPattern.intervalName", - "type": "string", "label": "intervalName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 58 }, - "signature": [ - "string | undefined" - ] + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nType is used to identify rollup index patterns" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 62 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.formatHit", "type": "Function", + "tags": [], "label": "formatHit", "description": [], + "signature": [ + "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 63 }, - "signature": [ - "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.formatField", "type": "Function", + "tags": [], "label": "formatField", "description": [], + "signature": [ + "FormatFieldFn" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 67 }, - "signature": [ - "FormatFieldFn" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.flattenHit", "type": "Function", + "tags": [], "label": "flattenHit", "description": [], + "signature": [ + "(hit: Record, deep?: boolean | undefined) => Record" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 68 }, - "signature": [ - "(hit: Record, deep?: boolean | undefined) => Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.metaFields", "type": "Array", + "tags": [], "label": "metaFields", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 69 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.version", "type": "string", + "tags": [], "label": "version", "description": [ "\nSavedObject version" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 73 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.sourceFilters", "type": "Array", + "tags": [], "label": "sourceFilters", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 74 - }, "signature": [ { "pluginId": "data", @@ -3254,12 +3628,18 @@ "text": "SourceFilter" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 74 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPattern.allowNoIndex", "type": "boolean", + "tags": [], "label": "allowNoIndex", "description": [ "\nprevents errors when index pattern exists before indices" @@ -3267,79 +3647,92 @@ "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 84 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.Unnamed.$1", "type": "Object", + "tags": [], "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", - "isRequired": true, + "description": [], "signature": [ "IndexPatternDeps" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 86 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getOriginalSavedObjectBody", "type": "Function", - "children": [], - "signature": [ - "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" - ], + "tags": [], + "label": "getOriginalSavedObjectBody", "description": [ "\nGet last saved saved object fields" ], - "label": "getOriginalSavedObjectBody", + "signature": [ + "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 128 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.resetOriginalSavedObjectBody", "type": "Function", - "children": [], - "signature": [ - "() => void" - ], + "tags": [], + "label": "resetOriginalSavedObjectBody", "description": [ "\nReset last saved saved object fields. used after saving" ], - "label": "resetOriginalSavedObjectBody", + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 133 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getFieldAttrs", "type": "Function", - "children": [], + "tags": [], + "label": "getFieldAttrs", + "description": [], "signature": [ "() => { [x: string]: ", { @@ -3351,19 +3744,21 @@ }, "; }" ], - "description": [], - "label": "getFieldAttrs", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 137 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getComputedFields", "type": "Function", + "tags": [], "label": "getComputedFields", + "description": [], "signature": [ "() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 162 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.toSpec", "type": "Function", + "tags": [], "label": "toSpec", + "description": [ + "\nCreate static representation of index pattern" + ], "signature": [ "() => ", { @@ -3398,137 +3797,155 @@ "text": "IndexPatternSpec" } ], - "description": [ - "\nCreate static representation of index pattern" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getSourceFiltering", "type": "Function", + "tags": [], "label": "getSourceFiltering", - "signature": [ - "() => { excludes: any[]; }" - ], "description": [ "\nGet the source filtering configuration for that index." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => { excludes: any[]; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 230 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.addScriptedField", "type": "Function", + "tags": [], "label": "addScriptedField", - "signature": [ - "(name: string, script: string, fieldType?: string) => Promise" - ], "description": [ "\nAdd scripted field to field list\n" ], + "signature": [ + "(name: string, script: string, fieldType?: string) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.addScriptedField.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "field name" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.addScriptedField.$2", "type": "string", + "tags": [], "label": "script", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "script code" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.addScriptedField.$3", "type": "string", + "tags": [], "label": "fieldType", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.removeScriptedField", "type": "Function", + "tags": [], "label": "removeScriptedField", - "signature": [ - "(fieldName: string) => void" - ], "description": [ "\nRemove scripted field from field list" ], + "signature": [ + "(fieldName: string) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.removeScriptedField.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 270 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 270 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getNonScriptedFields", "type": "Function", + "tags": [], "label": "getNonScriptedFields", + "description": [], "signature": [ "() => ", { @@ -3540,19 +3957,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 277 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getScriptedFields", "type": "Function", + "tags": [], "label": "getScriptedFields", + "description": [], "signature": [ "() => ", { @@ -3564,51 +3983,57 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 281 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.isTimeBased", "type": "Function", + "tags": [], "label": "isTimeBased", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 285 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.isTimeNanosBased", "type": "Function", + "tags": [], "label": "isTimeNanosBased", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 289 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getTimeField", "type": "Function", + "tags": [], "label": "getTimeField", + "description": [], "signature": [ "() => ", { @@ -3620,19 +4045,21 @@ }, " | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 294 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getFieldByName", "type": "Function", + "tags": [], "label": "getFieldByName", + "description": [], "signature": [ "(name: string) => ", { @@ -3644,68 +4071,79 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.getFieldByName.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 299 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 299 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getAggregationRestrictions", "type": "Function", + "tags": [], "label": "getAggregationRestrictions", + "description": [], "signature": [ "() => Record> | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 304 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getAsSavedObjectBody", "type": "Function", + "tags": [], "label": "getAsSavedObjectBody", - "signature": [ - "() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }" - ], "description": [ "\nReturns index pattern as saved object body for saving" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 311 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getFormatterForField", "type": "Function", + "tags": [], "label": "getFormatterForField", + "description": [ + "\nProvide a field, get its formatter" + ], "signature": [ "(field: ", { @@ -3740,15 +4178,19 @@ "text": "FieldFormat" } ], - "description": [ - "\nProvide a field, get its formatter" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 339 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.getFormatterForField.$1", "type": "CompoundType", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3774,24 +4216,25 @@ "text": "FieldSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 340 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 339 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.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: ", { @@ -3803,31 +4246,40 @@ }, ") => void" ], - "description": [ - "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.addRuntimeField.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Field name" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 360 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.addRuntimeField.$2", "type": "Object", + "tags": [], "label": "runtimeField", - "isRequired": true, + "description": [ + "Runtime field definition" + ], "signature": [ { "pluginId": "data", @@ -3837,61 +4289,65 @@ "text": "RuntimeField" } ], - "description": [ - "Runtime field definition" - ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 360 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.removeRuntimeField", "type": "Function", + "tags": [], "label": "removeRuntimeField", - "signature": [ - "(name: string) => void" - ], "description": [ "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate" ], + "signature": [ + "(name: string) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.removeRuntimeField.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Field name" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 384 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 384 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.getFormatterForFieldNoDefault", "type": "Function", + "tags": [], "label": "getFormatterForFieldNoDefault", + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists" + ], "signature": [ "(fieldname: string) => ", { @@ -3903,36 +4359,39 @@ }, " | undefined" ], - "description": [ - "\nGet formatter for a given field name. Return undefined if none exists" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.getFormatterForFieldNoDefault.$1", "type": "string", + "tags": [], "label": "fieldname", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 404 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 404 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldAttrs", "type": "Function", + "tags": [], "label": "setFieldAttrs", + "description": [], "signature": [ "(fieldName: string, attrName: K, value: ", { @@ -3944,41 +4403,53 @@ }, "[K]) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 411 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldAttrs.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 412 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldAttrs.$2", "type": "Uncategorized", + "tags": [], "label": "attrName", - "isRequired": true, + "description": [], "signature": [ "K" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 413 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldAttrs.$3", "type": "Uncategorized", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3989,133 +4460,170 @@ }, "[K]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 414 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 411 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldCustomLabel", "type": "Function", + "tags": [], "label": "setFieldCustomLabel", + "description": [], "signature": [ "(fieldName: string, customLabel: string | null | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldCustomLabel.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 422 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldCustomLabel.$2", "type": "CompoundType", + "tags": [], "label": "customLabel", - "isRequired": false, + "description": [], "signature": [ "string | null | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 422 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldCount", "type": "Function", + "tags": [], "label": "setFieldCount", + "description": [], "signature": [ "(fieldName: string, count: number | null | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldCount.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 433 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldCount.$2", "type": "CompoundType", + "tags": [], "label": "count", - "isRequired": false, + "description": [], "signature": [ "number | null | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 433 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldFormat", "type": "Function", + "tags": [], + "label": "setFieldFormat", + "description": [], + "signature": [ + "(fieldName: string, format: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldFormat.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 446 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.setFieldFormat.$2", "type": "Object", + "tags": [], "label": "format", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -4126,72 +4634,57 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 446 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(fieldName: string, format: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - ">) => void" - ], - "description": [], - "label": "setFieldFormat", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPattern.deleteFieldFormat", "type": "Function", + "tags": [], + "label": "deleteFieldFormat", + "description": [], + "signature": [ + "(fieldName: string) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPattern.deleteFieldFormat.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 450 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(fieldName: string) => void" - ], - "description": [], - "label": "deleteFieldFormat", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 450 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField", "type": "Class", "tags": [], @@ -4214,17 +4707,19 @@ "text": "IFieldType" } ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternField.spec", "type": "Object", + "tags": [], "label": "spec", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 17 - }, "signature": [ { "pluginId": "data", @@ -4233,22 +4728,36 @@ "section": "def-common.FieldSpec", "text": "FieldSpec" } - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 17 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternField.Unnamed.$1", "type": "Object", + "tags": [], "label": "spec", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -4258,54 +4767,51 @@ "text": "FieldSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 21 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.count", "type": "number", - "label": "count", "tags": [], + "label": "count", "description": [ "\nCount is used for field popularity" ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.count", "type": "number", - "label": "count", "tags": [], + "label": "count", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 35 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.runtimeField", "type": "Object", - "label": "runtimeField", "tags": [], + "label": "runtimeField", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 39 - }, "signature": [ { "pluginId": "data", @@ -4315,18 +4821,20 @@ "text": "RuntimeField" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 39 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.runtimeField", "type": "Object", - "label": "runtimeField", "tags": [], + "label": "runtimeField", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 43 - }, "signature": [ { "pluginId": "data", @@ -4336,227 +4844,261 @@ "text": "RuntimeField" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 43 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.script", "type": "string", - "label": "script", "tags": [], + "label": "script", "description": [ "\nScript field code" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 50 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.script", "type": "string", - "label": "script", "tags": [], + "label": "script", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 54 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.lang", "type": "string", - "label": "lang", "tags": [], + "label": "lang", "description": [ "\nScript field language" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 61 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.lang", "type": "string", - "label": "lang", "tags": [], + "label": "lang", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 65 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.customLabel", "type": "string", - "label": "customLabel", "tags": [], + "label": "customLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 69 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.customLabel", "type": "string", - "label": "customLabel", "tags": [], + "label": "customLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 73 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.conflictDescriptions", "type": "Object", - "label": "conflictDescriptions", "tags": [], + "label": "conflictDescriptions", "description": [ "\nDescription of field type conflicts across different indices in the same index pattern" ], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 80 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.conflictDescriptions", "type": "Object", - "label": "conflictDescriptions", "tags": [], + "label": "conflictDescriptions", "description": [], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 84 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.name", "type": "string", - "label": "name", "tags": [], + "label": "name", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 89 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.displayName", "type": "string", - "label": "displayName", "tags": [], + "label": "displayName", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 93 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.type", "type": "string", - "label": "type", "tags": [], + "label": "type", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 101 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.esTypes", "type": "Array", - "label": "esTypes", "tags": [], + "label": "esTypes", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 107 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.scripted", "type": "boolean", - "label": "scripted", "tags": [], + "label": "scripted", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 111 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.searchable", "type": "boolean", - "label": "searchable", "tags": [], + "label": "searchable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 115 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.aggregatable", "type": "boolean", - "label": "aggregatable", "tags": [], + "label": "aggregatable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 119 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.readFromDocValues", "type": "boolean", - "label": "readFromDocValues", "tags": [], + "label": "readFromDocValues", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 123 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.subType", "type": "Object", - "label": "subType", "tags": [], + "label": "subType", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 127 - }, "signature": [ { "pluginId": "data", @@ -4566,77 +5108,95 @@ "text": "IFieldSubType" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 127 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.isMapped", "type": "CompoundType", - "label": "isMapped", "tags": [], + "label": "isMapped", "description": [ "\nIs the field part of the index mapping?" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 134 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.sortable", "type": "boolean", - "label": "sortable", "tags": [], + "label": "sortable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 139 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.filterable", "type": "boolean", - "label": "filterable", "tags": [], + "label": "filterable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 146 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.visualizable", "type": "boolean", - "label": "visualizable", "tags": [], + "label": "visualizable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 154 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.deleteCount", "type": "Function", + "tags": [], "label": "deleteCount", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 159 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.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: ", { @@ -4648,19 +5208,21 @@ }, " | undefined; customLabel: string | undefined; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 163 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternField.toSpec", "type": "Function", + "tags": [], "label": "toSpec", + "description": [], "signature": [ "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", { @@ -4703,25 +5265,32 @@ "text": "FieldSpec" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 181 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternField.toSpec.$1.getFormatterForField", "type": "Object", - "label": "{\n getFormatterForField,\n }", "tags": [], + "label": "{\n getFormatterForField,\n }", "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 183 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternField.toSpec.$1.getFormatterForField.getFormatterForField", "type": "Function", + "tags": [], "label": "getFormatterForField", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 184 - }, "signature": [ "((field: ", { @@ -4756,274 +5325,310 @@ "text": "FieldFormat" }, ") | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 184 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 183 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 181 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService", "type": "Class", "tags": [], "label": "IndexPatternsService", "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternsService.ensureDefaultIndexPattern", "type": "Function", + "tags": [], "label": "ensureDefaultIndexPattern", "description": [], + "signature": [ + "EnsureDefaultIndexPattern" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "signature": [ - "EnsureDefaultIndexPattern" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.Unnamed.$1", "type": "Object", + "tags": [], "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", - "isRequired": true, + "description": [], "signature": [ "IndexPatternsServiceDeps" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 69 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 69 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.getIds", "type": "Function", + "tags": [], + "label": "getIds", + "description": [ + "\nGet list of index pattern ids" + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.getIds.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 108 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.IndexPatternsService.getTitles", + "type": "Function", + "tags": [], + "label": "getTitles", + "description": [ + "\nGet list of index pattern titles" + ], "signature": [ "(refresh?: boolean) => Promise" ], - "description": [ - "\nGet list of index pattern ids" - ], - "label": "getIds", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 108 + "lineNumber": 122 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.IndexPatternsService.getTitles", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.getTitles.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 122 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(refresh?: boolean) => Promise" - ], - "description": [ - "\nGet list of index pattern titles" - ], - "label": "getTitles", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 122 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.find", "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nFind and load index patterns by title" + ], + "signature": [ + "(search: string, size?: number) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "[]>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.find.$1", "type": "string", + "tags": [], "label": "search", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.find.$2", "type": "number", + "tags": [], "label": "size", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "IndexPattern[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-public.IndexPatternsService.getIdsWithTitle", + "type": "Function", + "tags": [], + "label": "getIdsWithTitle", + "description": [ + "\nGet list of index pattern ids with titles" + ], "signature": [ - "(search: string, size?: number) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - "[]>" - ], - "description": [ - "\nFind and load index patterns by title" + "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" ], - "label": "find", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 138 + "lineNumber": 156 }, - "tags": [], - "returnComment": [ - "IndexPattern[]" - ] - }, - { - "id": "def-public.IndexPatternsService.getIdsWithTitle", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.getIdsWithTitle.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 157 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" - ], - "description": [ - "\nGet list of index pattern ids with titles" - ], - "label": "getIdsWithTitle", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 156 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.clearCache", "type": "Function", + "tags": [], + "label": "clearCache", + "description": [ + "\nClear index pattern list cache" + ], + "signature": [ + "(id?: string | undefined) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.clearCache.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 175 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(id?: string | undefined) => void" - ], - "description": [ - "\nClear index pattern list cache" - ], - "label": "clearCache", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 175 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.getCache", "type": "Function", - "children": [], + "tags": [], + "label": "getCache", + "description": [], "signature": [ "() => Promise<", "SavedObject", @@ -5031,19 +5636,23 @@ "IndexPatternSavedObjectAttrs", ">[] | null | undefined>" ], - "description": [], - "label": "getCache", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 184 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.getDefault", "type": "Function", - "children": [], + "tags": [], + "label": "getDefault", + "description": [ + "\nGet default index pattern" + ], "signature": [ "() => Promise<", { @@ -5055,73 +5664,102 @@ }, " | null>" ], - "description": [ - "\nGet default index pattern" - ], - "label": "getDefault", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 194 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.setDefault", "type": "Function", + "tags": [], + "label": "setDefault", + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], + "signature": [ + "(id: string, force?: boolean) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.setDefault.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.setDefault.$2", "type": "boolean", + "tags": [], "label": "force", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(id: string, force?: boolean) => Promise" - ], - "description": [ - "\nOptionally set default index pattern, unless force = true" - ], - "label": "setDefault", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 208 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.getFieldsForWildcard", "type": "Function", + "tags": [], + "label": "getFieldsForWildcard", + "description": [ + "\nGet field list by providing { pattern }" + ], + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.getFieldsForWildcard.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5131,15 +5769,45 @@ "text": "GetFieldsOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 219 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-public.IndexPatternsService.getFieldsForIndexPattern", + "type": "Function", + "tags": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet field list by providing an index patttern (or spec)" + ], "signature": [ - "(options: ", + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", options?: ", { "pluginId": "data", "scope": "common", @@ -5147,30 +5815,21 @@ "section": "def-common.GetFieldsOptions", "text": "GetFieldsOptions" }, - ") => Promise" - ], - "description": [ - "\nGet field list by providing { pattern }" + " | undefined) => Promise" ], - "label": "getFieldsForWildcard", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 219 + "lineNumber": 235 }, - "tags": [], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "id": "def-public.IndexPatternsService.getFieldsForIndexPattern", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.getFieldsForIndexPattern.$1", "type": "CompoundType", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5188,17 +5847,20 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 236 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.getFieldsForIndexPattern.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -5209,13 +5871,27 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 237 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-public.IndexPatternsService.refreshFields", + "type": "Function", + "tags": [], + "label": "refreshFields", + "description": [ + "\nRefresh field list for a given index pattern" + ], "signature": [ "(indexPattern: ", { @@ -5225,46 +5901,21 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" }, - " | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - }, - ", options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise" - ], - "description": [ - "\nGet field list by providing an index patttern (or spec)" + ") => Promise" ], - "label": "getFieldsForIndexPattern", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 235 + "lineNumber": 250 }, - "tags": [], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "id": "def-public.IndexPatternsService.refreshFields", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.refreshFields.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5274,44 +5925,65 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 250 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(indexPattern: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ") => Promise" - ], - "description": [ - "\nRefresh field list for a given index pattern" - ], - "label": "refreshFields", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 250 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.fieldArrayToMap", "type": "Function", + "tags": [], + "label": "fieldArrayToMap", + "description": [ + "\nConverts field array to map" + ], + "signature": [ + "(fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => Record" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.fieldArrayToMap.$1", "type": "Array", + "tags": [], "label": "fields", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5322,17 +5994,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 327 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.fieldArrayToMap.$2", "type": "Object", + "tags": [], "label": "fieldAttrs", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -5343,62 +6018,60 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 327 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [ + "Record" + ] + }, + { + "parentPluginId": "data", + "id": "def-public.IndexPatternsService.savedObjectToSpec", + "type": "Function", + "tags": [], + "label": "savedObjectToSpec", + "description": [ + "\nConverts index pattern saved object to index pattern spec" + ], "signature": [ - "(fields: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", + "(savedObject: ", + "SavedObject", + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" }, - " | undefined) => Record) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ">" - ], - "description": [ - "\nConverts field array to map" + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } ], - "label": "fieldArrayToMap", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 327 + "lineNumber": 343 }, - "tags": [], - "returnComment": [ - "Record" - ] - }, - { - "id": "def-public.IndexPatternsService.savedObjectToSpec", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.savedObjectToSpec.$1", "type": "Object", + "tags": [], "label": "savedObject", - "isRequired": true, + "description": [], "signature": [ "SavedObject", "<", @@ -5411,64 +6084,26 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 343 - } - } - ], - "signature": [ - "(savedObject: ", - "SavedObject", - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternAttributes", - "text": "IndexPatternAttributes" - }, - ">) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" + }, + "deprecated": false, + "isRequired": true } ], - "description": [ - "\nConverts index pattern saved object to index pattern spec" - ], - "label": "savedObjectToSpec", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 343 - }, - "tags": [], "returnComment": [ "IndexPatternSpec" ] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.get", "type": "Function", - "children": [ - { - "id": "def-public.IndexPatternsService.get.$1", - "type": "string", - "label": "id", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 465 - } - } + "tags": [], + "label": "get", + "description": [ + "\nGet an index pattern by id. Cache optimized" ], "signature": [ "(id: string) => Promise<", @@ -5481,21 +6116,41 @@ }, ">" ], - "description": [ - "\nGet an index pattern by id. Cache optimized" - ], - "label": "get", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 465 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.IndexPatternsService.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 465 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.create", "type": "Function", + "tags": [], "label": "create", + "description": [ + "\nCreate a new index pattern instance" + ], "signature": [ "(spec: ", { @@ -5515,15 +6170,19 @@ }, ">" ], - "description": [ - "\nCreate a new index pattern instance" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 484 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.create.$1", "type": "Object", + "tags": [], "label": "spec", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5533,40 +6192,44 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 484 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.create.$2", "type": "boolean", + "tags": [], "label": "skipFetchFields", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 484 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "IndexPattern" - ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 484 - } + ] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.createAndSave", "type": "Function", + "tags": [], "label": "createAndSave", + "description": [ + "\nCreate a new index pattern and save it right away" + ], "signature": [ "(spec: ", { @@ -5586,15 +6249,19 @@ }, ">" ], - "description": [ - "\nCreate a new index pattern and save it right away" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 509 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.createAndSave.$1", "type": "Object", + "tags": [], "label": "spec", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5604,56 +6271,63 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.createAndSave.$2", "type": "boolean", + "tags": [], "label": "override", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Overwrite if existing index pattern exists." ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.createAndSave.$3", "type": "boolean", + "tags": [], "label": "skipFetchFields", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Whether to skip field refresh step." ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 509 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.createSavedObject", "type": "Function", + "tags": [], "label": "createSavedObject", + "description": [ + "\nSave a new index pattern" + ], "signature": [ "(indexPattern: ", { @@ -5673,15 +6347,19 @@ }, ">" ], - "description": [ - "\nSave a new index pattern" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 522 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.createSavedObject.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5691,40 +6369,44 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 522 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.createSavedObject.$2", "type": "boolean", + "tags": [], "label": "override", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Overwrite if existing index pattern exists" ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 522 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 522 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.updateSavedObject", "type": "Function", + "tags": [], "label": "updateSavedObject", + "description": [ + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + ], "signature": [ "(indexPattern: ", { @@ -5736,15 +6418,19 @@ }, ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], - "description": [ - "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 550 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.updateSavedObject.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5754,91 +6440,95 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 551 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.updateSavedObject.$2", "type": "number", + "tags": [], "label": "saveAttempts", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 552 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.updateSavedObject.$3", "type": "boolean", + "tags": [], "label": "ignoreErrors", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 553 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 550 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.delete", "type": "Function", + "tags": [], "label": "delete", - "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], "description": [ "\nDeletes an index pattern from .kibana index" ], + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 636 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.delete.$1", "type": "string", + "tags": [], "label": "indexPatternId", - "isRequired": true, - "signature": [ - "string" - ], "description": [ ": Id of kibana Index Pattern to delete" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 636 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 636 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.OptionedParamType", "type": "Class", "tags": [], @@ -5870,17 +6560,19 @@ }, ">" ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.OptionedParamType.options", "type": "Array", + "tags": [], "label": "options", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 20 - }, "signature": [ { "pluginId": "data", @@ -5890,83 +6582,104 @@ "text": "OptionedValueProp" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 20 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.OptionedParamType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.OptionedParamType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 22 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SearchSource", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SearchSource", "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 121 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSource.history", "type": "Array", + "tags": [], "label": "history", "description": [], + "signature": [ + "Record[]" + ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 111 + "lineNumber": 129 }, - "signature": [ - "Record[]" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.SearchSource.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 133 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.Unnamed.$1", "type": "Object", + "tags": [], "label": "fields", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5976,17 +6689,20 @@ "text": "SearchSourceFields" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 - } + "lineNumber": 133 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.SearchSource.Unnamed.$2", "type": "Object", + "tags": [], "label": "dependencies", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5996,57 +6712,63 @@ "text": "SearchSourceDependencies" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 - } + "lineNumber": 133 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.setPreferredSearchStrategyId", "type": "Function", + "tags": [], "label": "setPreferredSearchStrategyId", - "signature": [ - "(searchStrategyId: string) => void" - ], "description": [ "**\nPUBLIC API\n\ninternal, dont use" ], + "signature": [ + "(searchStrategyId: string) => void" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 151 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.setPreferredSearchStrategyId.$1", "type": "string", + "tags": [], "label": "searchStrategyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 - } + "lineNumber": 151 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 - } + "returnComment": [] }, { + "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: ", { @@ -6058,31 +6780,40 @@ }, "[K]) => this" ], - "description": [ - "\nsets value to a single search source field" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 160 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.setField.$1", "type": "Uncategorized", + "tags": [], "label": "field", - "isRequired": true, - "signature": [ - "K" - ], "description": [ ": field name" ], + "signature": [ + "K" + ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 - } + "lineNumber": 160 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.SearchSource.setField.$2", "type": "Uncategorized", + "tags": [], "label": "value", - "isRequired": true, + "description": [ + ": value for the field" + ], "signature": [ { "pluginId": "data", @@ -6093,61 +6824,67 @@ }, "[K]" ], - "description": [ - ": value for the field" - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 - } + "lineNumber": 160 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.removeField", "type": "Function", + "tags": [], "label": "removeField", - "signature": [ - "(field: K) => this" - ], "description": [ "\nremove field" ], + "signature": [ + "(field: K) => this" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 172 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.removeField.$1", "type": "Uncategorized", + "tags": [], "label": "field", - "isRequired": true, - "signature": [ - "K" - ], "description": [ ": field name" ], + "signature": [ + "K" + ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154 - } + "lineNumber": 172 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154 - } + "returnComment": [] }, { + "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: ", { @@ -6159,15 +6896,21 @@ }, ") => this" ], - "description": [ - "\nInternal, do not use. Overrides all search source fields with the new field array.\n" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 183 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.setFields.$1", "type": "Object", + "tags": [], "label": "newFields", - "isRequired": true, + "description": [ + "New field array." + ], "signature": [ { "pluginId": "data", @@ -6177,46 +6920,45 @@ "text": "SearchSourceFields" } ], - "description": [ - "New field array." - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165 - } + "lineNumber": 183 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "private" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.getId", "type": "Function", + "tags": [], "label": "getId", - "signature": [ - "() => string" - ], "description": [ "\nreturns search source id" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 173 - } + "lineNumber": 191 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.getFields", "type": "Function", + "tags": [], "label": "getFields", + "description": [ + "\nreturns all search source fields" + ], "signature": [ "() => ", { @@ -6227,21 +6969,23 @@ "text": "SearchSourceFields" } ], - "description": [ - "\nreturns all search source fields" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 180 - } + "lineNumber": 198 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "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) => ", { @@ -6253,50 +6997,58 @@ }, "[K]" ], - "description": [ - "\nGets a single field from the fields" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 205 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.getField.$1", "type": "Uncategorized", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ "K" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 - } + "lineNumber": 205 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.SearchSource.getField.$2", "type": "boolean", + "tags": [], "label": "recurse", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 - } + "lineNumber": 205 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 - } + "returnComment": [] }, { + "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) => ", { @@ -6308,36 +7060,41 @@ }, "[K]" ], - "description": [ - "\nGet the field from our own fields, don't traverse up the chain" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 216 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.getOwnField.$1", "type": "Uncategorized", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ "K" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198 - } + "lineNumber": 216 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.create", "type": "Function", + "tags": [ + "deprecated" + ], "label": "create", + "description": [], "signature": [ "() => ", { @@ -6348,21 +7105,39 @@ "text": "SearchSource" } ], - "description": [], - "children": [], - "tags": [ - "deprecated" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 - } + "lineNumber": 223 + }, + "deprecated": true, + "references": [ + { + "plugin": "discover", + "link": { + "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", + "lineNumber": 206 + } + }, + { + "plugin": "discover", + "link": { + "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", + "lineNumber": 212 + } + } + ], + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.createCopy", "type": "Function", + "tags": [], "label": "createCopy", + "description": [ + "\ncreates a copy of this search source (without its children)" + ], "signature": [ "() => ", { @@ -6373,21 +7148,23 @@ "text": "SearchSource" } ], - "description": [ - "\ncreates a copy of this search source (without its children)" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 212 - } + "lineNumber": 230 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.createChild", "type": "Function", + "tags": [], "label": "createChild", + "description": [ + "\ncreates a new child search source" + ], "signature": [ "(options?: {}) => ", { @@ -6398,36 +7175,43 @@ "text": "SearchSource" } ], - "description": [ - "\ncreates a new child search source" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 244 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.createChild.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ "{}" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226 - } + "lineNumber": 244 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.setParent", "type": "Function", + "tags": [ + "return" + ], "label": "setParent", + "description": [ + "\nSet a searchSource that this source should inherit from" + ], "signature": [ "(parent?: Pick<", { @@ -6447,15 +7231,21 @@ }, ") => this" ], - "description": [ - "\nSet a searchSource that this source should inherit from" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 256 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.setParent.$1", "type": "Object", + "tags": [], "label": "parent", - "isRequired": false, + "description": [ + "- the parent searchSource" + ], "signature": [ "Pick<", { @@ -6467,19 +7257,22 @@ }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" ], - "description": [ - "- the parent searchSource" - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 - } + "lineNumber": 256 + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-public.SearchSource.setParent.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [ + "- the inherit options" + ], "signature": [ { "pluginId": "data", @@ -6489,30 +7282,29 @@ "text": "SearchSourceOptions" } ], - "description": [ - "- the inherit options" - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 - } + "lineNumber": 256 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "- chainable" - ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 - } + ] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.getParent", "type": "Function", + "tags": [ + "return" + ], "label": "getParent", + "description": [ + "\nGet the parent of this SearchSource" + ], "signature": [ "() => ", { @@ -6524,23 +7316,23 @@ }, " | undefined" ], - "description": [ - "\nGet the parent of this SearchSource" - ], - "children": [], - "tags": [ - "return" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 248 - } + "lineNumber": 266 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.fetch$", "type": "Function", + "tags": [], "label": "fetch$", + "description": [ + "\nFetch this source from Elasticsearch, returning an observable over the response(s)" + ], "signature": [ "(options?: ", { @@ -6553,18 +7345,30 @@ ") => ", "Observable", "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", "SearchResponse", - ">" - ], - "description": [ - "\nFetch this source from Elasticsearch, returning an observable over the response(s)" + ">>" ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 274 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.fetch$.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -6574,25 +7378,28 @@ "text": "ISearchOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 - } + "lineNumber": 275 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.fetch", "type": "Function", - "label": "fetch", - "signature": [ + "tags": [ + "deprecated" + ], + "label": "fetch", + "description": [ + "\nFetch this source and reject the returned Promise on error" + ], + "signature": [ "(options?: ", { "pluginId": "data", @@ -6605,15 +7412,56 @@ "SearchResponse", ">" ], - "description": [ - "\nFetch this source and reject the returned Promise on error" + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 312 + }, + "deprecated": true, + "references": [ + { + "plugin": "discover", + "link": { + "path": "src/plugins/discover/public/application/angular/context/api/utils/fetch_hits_in_interval.ts", + "lineNumber": 77 + } + }, + { + "plugin": "discover", + "link": { + "path": "src/plugins/discover/public/application/angular/context/api/anchor.ts", + "lineNumber": 57 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts", + "lineNumber": 266 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx", + "lineNumber": 498 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/public/classes/layers/blended_vector_layer/blended_vector_layer.ts", + "lineNumber": 330 + } + } ], "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.fetch.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -6623,26 +7471,27 @@ "text": "ISearchOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283 - } + "lineNumber": 312 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "deprecated" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283 - } + "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: ", { @@ -6662,15 +7511,19 @@ }, " | undefined) => Promise) => void" ], - "description": [ - "\n Add a handler that will be notified whenever requests start" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 325 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.onRequestStart.$1", "type": "Function", + "tags": [], "label": "handler", - "isRequired": true, + "description": [], "signature": [ "(searchSource: ", { @@ -6690,64 +7543,67 @@ }, " | undefined) => Promise" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 293 - } + "lineNumber": 326 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 292 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.getSearchRequestBody", "type": "Function", + "tags": [], "label": "getSearchRequestBody", - "signature": [ - "() => Promise" - ], "description": [ "\nReturns body contents of the search request, often referred as query DSL." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => any" + ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 301 - } + "lineNumber": 334 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.destroy", "type": "Function", - "label": "destroy", - "signature": [ - "() => void" + "tags": [ + "return" ], + "label": "destroy", "description": [ "\nCompletely destroy the SearchSource." ], - "children": [], - "tags": [ - "return" + "signature": [ + "() => void" ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 310 - } + "lineNumber": 342 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.getSerializedFields", "type": "Function", + "tags": [], "label": "getSerializedFields", + "description": [ + "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" + ], "signature": [ "(recurse?: boolean) => ", { @@ -6758,81 +7614,69 @@ "text": "SearchSourceFields" } ], - "description": [ - "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 826 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchSource.getSerializedFields.$1", "type": "boolean", + "tags": [], "label": "recurse", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688 - } + "lineNumber": 826 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688 - } + "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", "[]; }" ], - "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." - ], - "children": [], - "tags": [ - "public" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 717 - } + "lineNumber": 855 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 103 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "data", "id": "def-public.castEsToKbnFieldTypeName", "type": "Function", - "children": [ - { - "id": "def-public.castEsToKbnFieldTypeName.$1", - "type": "string", - "label": "esType", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", - "lineNumber": 39 - } - } + "tags": [ + "return" + ], + "label": "castEsToKbnFieldTypeName", + "description": [ + "\n Get the KbnFieldType name for an esType string\n" ], "signature": [ "(esType: string) => ", @@ -6844,45 +7688,40 @@ "text": "KBN_FIELD_TYPES" } ], - "description": [ - "\n Get the KbnFieldType name for an esType string\n" - ], - "label": "castEsToKbnFieldTypeName", "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", "lineNumber": 39 }, - "tags": [ - "return" - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.extractReferences", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.extractReferences.$1", - "type": "Object", - "label": "state", - "isRequired": true, + "parentPluginId": "data", + "id": "def-public.castEsToKbnFieldTypeName.$1", + "type": "string", + "tags": [], + "label": "esType", + "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + "string" ], - "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/extract_references.ts", - "lineNumber": 14 - } + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 39 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.extractReferences", + "type": "Function", + "tags": [], + "label": "extractReferences", + "description": [], "signature": [ "(state: ", { @@ -6904,25 +7743,77 @@ "SavedObjectReference", "[]]" ], - "description": [], - "label": "extractReferences", "source": { "path": "src/plugins/data/common/search/search_source/extract_references.ts", "lineNumber": 13 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.extractReferences.$1", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/extract_references.ts", + "lineNumber": 14 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.fieldList", "type": "Function", + "tags": [], + "label": "fieldList", + "description": [], + "signature": [ + "(specs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], shortDotsEnable?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.fieldList.$1", "type": "Array", + "tags": [], "label": "specs", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -6933,80 +7824,64 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.fieldList.$2", "type": "boolean", + "tags": [], "label": "shortDotsEnable", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 36 - } - } - ], - "signature": [ - "(specs?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], shortDotsEnable?: boolean) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "fieldList", - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 34 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.getKbnTypeNames", "type": "Function", - "children": [], - "signature": [ - "() => string[]" + "tags": [ + "return" ], + "label": "getKbnTypeNames", "description": [ "\n Get the esTypes known by all kbnFieldTypes\n" ], - "label": "getKbnTypeNames", + "signature": [ + "() => string[]" + ], "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", "lineNumber": 30 }, - "tags": [ - "return" - ], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.getSearchParamsFromRequest", "type": "Function", + "tags": [], "label": "getSearchParamsFromRequest", + "description": [], "signature": [ "(searchRequest: Record, dependencies: { getConfig: ", { @@ -7025,39 +7900,49 @@ "text": "ISearchRequestParams" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.getSearchParamsFromRequest.$1", "type": "Object", + "tags": [], "label": "searchRequest", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.getSearchParamsFromRequest.$2.dependencies", "type": "Object", - "label": "dependencies", "tags": [], + "label": "dependencies", "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.getSearchParamsFromRequest.$2.dependencies.getConfig", "type": "Function", + "tags": [], "label": "getConfig", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "lineNumber": 35 - }, "signature": [ { "pluginId": "data", @@ -7066,29 +7951,26 @@ "section": "def-common.GetConfigFn", "text": "GetConfigFn" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "lineNumber": 35 - } + ] } ], - "tags": [ - "public" - ], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "lineNumber": 33 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.getTime", "type": "Function", + "tags": [], "label": "getTime", + "description": [], "signature": [ "(indexPattern: ", { @@ -7116,13 +7998,19 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.getTime.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -7133,17 +8021,20 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-public.getTime.$2", "type": "Object", + "tags": [], "label": "timeRange", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -7153,71 +8044,104 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.getTime.$3.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.getTime.$3.options.forceNow", "type": "Object", + "tags": [], "label": "forceNow", "description": [], + "signature": [ + "Date | undefined" + ], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 40 }, - "signature": [ - "Date | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.getTime.$3.options.fieldName", "type": "string", + "tags": [], "label": "fieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 40 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "lineNumber": 40 - } + ] } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "lineNumber": 37 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.injectReferences", "type": "Function", + "tags": [], + "label": "injectReferences", + "description": [], + "signature": [ + "(searchSourceFields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " & { indexRefName: string; }, references: ", + "SavedObjectReference", + "[]) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.injectReferences.$1", "type": "CompoundType", + "tags": [], "label": "searchSourceFields", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -7228,67 +8152,66 @@ }, " & { indexRefName: string; }" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/inject_references.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.injectReferences.$2", "type": "Array", + "tags": [], "label": "references", - "isRequired": true, + "description": [], "signature": [ "SavedObjectReference", "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/inject_references.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.isCompleteResponse", + "type": "Function", + "tags": [], + "label": "isCompleteResponse", + "description": [], "signature": [ - "(searchSourceFields: ", + "(response?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - " & { indexRefName: string; }, references: ", - "SavedObjectReference", - "[]) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + " | undefined) => boolean" ], - "description": [], - "label": "injectReferences", "source": { - "path": "src/plugins/data/common/search/search_source/inject_references.ts", - "lineNumber": 12 + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 21 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.isCompleteResponse", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.isCompleteResponse.$1", "type": "Object", + "tags": [], "label": "response", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -7299,13 +8222,26 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 21 - } + }, + "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?: ", { @@ -7315,29 +8251,21 @@ "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, - " | undefined) => boolean" + " | undefined) => boolean | undefined" ], - "description": [], - "label": "isCompleteResponse", "source": { "path": "src/plugins/data/common/search/utils.ts", - "lineNumber": 21 + "lineNumber": 14 }, - "tags": [], - "returnComment": [ - "true if response is completed successfully" - ], - "initialIsOpen": false - }, - { - "id": "def-public.isErrorResponse", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.isErrorResponse.$1", "type": "Object", + "tags": [], "label": "response", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -7348,55 +8276,26 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(response?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined) => boolean | undefined" - ], - "description": [], - "label": "isErrorResponse", - "source": { - "path": "src/plugins/data/common/search/utils.ts", - "lineNumber": 14 - }, - "tags": [], - "returnComment": [ - "true if response had an error while executing in ES" + "returnComment": [ + "true if response had an error while executing in ES" ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.isFilter", "type": "Function", - "children": [ - { - "id": "def-public.isFilter.$1", - "type": "Unknown", - "label": "x", - "isRequired": true, - "signature": [ - "unknown" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 103 - } - } - ], + "tags": [], + "label": "isFilter", + "description": [], "signature": [ "(x: unknown) => x is ", { @@ -7407,35 +8306,40 @@ "text": "Filter" } ], - "description": [], - "label": "isFilter", "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 103 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.isFilters", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.isFilters.$1", + "parentPluginId": "data", + "id": "def-public.isFilter.$1", "type": "Unknown", + "tags": [], "label": "x", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 110 - } + "lineNumber": 103 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.isFilters", + "type": "Function", + "tags": [], + "label": "isFilters", + "description": [], "signature": [ "(x: unknown) => x is ", { @@ -7447,25 +8351,64 @@ }, "[]" ], - "description": [], - "label": "isFilters", "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 110 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.isFilters.$1", + "type": "Unknown", + "tags": [], + "label": "x", + "description": [], + "signature": [ + "unknown" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 110 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "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" + ], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.isPartialResponse.$1", "type": "Object", + "tags": [], "label": "response", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -7476,55 +8419,26 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(response?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined) => boolean" - ], - "description": [], - "label": "isPartialResponse", - "source": { - "path": "src/plugins/data/common/search/utils.ts", - "lineNumber": 28 - }, - "tags": [], "returnComment": [ "true if request is still running an/d response contains partial results" ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.isQuery", "type": "Function", - "children": [ - { - "id": "def-public.isQuery.$1", - "type": "Unknown", - "label": "x", - "isRequired": true, - "signature": [ - "unknown" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/query/is_query.ts", - "lineNumber": 11 - } - } - ], + "tags": [], + "label": "isQuery", + "description": [], "signature": [ "(x: unknown) => x is ", { @@ -7535,35 +8449,40 @@ "text": "Query" } ], - "description": [], - "label": "isQuery", "source": { "path": "src/plugins/data/common/query/is_query.ts", "lineNumber": 11 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.isTimeRange", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.isTimeRange.$1", + "parentPluginId": "data", + "id": "def-public.isQuery.$1", "type": "Unknown", + "tags": [], "label": "x", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { - "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", + "path": "src/plugins/data/common/query/is_query.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.isTimeRange", + "type": "Function", + "tags": [], + "label": "isTimeRange", + "description": [], "signature": [ "(x: unknown) => x is ", { @@ -7574,35 +8493,40 @@ "text": "TimeRange" } ], - "description": [], - "label": "isTimeRange", "source": { "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", "lineNumber": 11 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.parseSearchSourceJSON", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.parseSearchSourceJSON.$1", - "type": "string", - "label": "searchSourceJSON", - "isRequired": true, + "parentPluginId": "data", + "id": "def-public.isTimeRange.$1", + "type": "Unknown", + "tags": [], + "label": "x", + "description": [], "signature": [ - "string" + "unknown" ], - "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/parse_json.ts", - "lineNumber": 12 - } + "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", + "lineNumber": 11 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.parseSearchSourceJSON", + "type": "Function", + "tags": [], + "label": "parseSearchSourceJSON", + "description": [], "signature": [ "(searchSourceJSON: string) => ", { @@ -7613,543 +8537,643 @@ "text": "SearchSourceFields" } ], - "description": [], - "label": "parseSearchSourceJSON", "source": { "path": "src/plugins/data/common/search/search_source/parse_json.ts", "lineNumber": 12 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.parseSearchSourceJSON.$1", + "type": "string", + "tags": [], + "label": "searchSourceJSON", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/parse_json.ts", + "lineNumber": 12 + }, + "deprecated": false, + "isRequired": true + } + ], "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." ], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 195 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggFilter", "type": "Object", + "tags": [], "label": "aggFilter", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 196 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggFilters", "type": "Object", + "tags": [], "label": "aggFilters", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 197 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggSignificantTerms", "type": "Object", + "tags": [], "label": "aggSignificantTerms", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 198 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggIpRange", "type": "Object", + "tags": [], "label": "aggIpRange", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 199 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggDateRange", "type": "Object", + "tags": [], "label": "aggDateRange", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 200 - }, "signature": [ "FunctionDefinition" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 200 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggRange", "type": "Object", + "tags": [], "label": "aggRange", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 201 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggGeoTile", "type": "Object", + "tags": [], "label": "aggGeoTile", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 202 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggGeoHash", "type": "Object", + "tags": [], "label": "aggGeoHash", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 203 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggHistogram", "type": "Object", + "tags": [], "label": "aggHistogram", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 204 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggDateHistogram", "type": "Object", + "tags": [], "label": "aggDateHistogram", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 205 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggTerms", "type": "Object", + "tags": [], "label": "aggTerms", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 206 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggAvg", "type": "Object", + "tags": [], "label": "aggAvg", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 207 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggBucketAvg", "type": "Object", + "tags": [], "label": "aggBucketAvg", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 208 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggBucketMax", "type": "Object", + "tags": [], "label": "aggBucketMax", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 209 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggBucketMin", "type": "Object", + "tags": [], "label": "aggBucketMin", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 210 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggBucketSum", "type": "Object", + "tags": [], "label": "aggBucketSum", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 211 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggFilteredMetric", "type": "Object", + "tags": [], "label": "aggFilteredMetric", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 212 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggCardinality", "type": "Object", + "tags": [], "label": "aggCardinality", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 213 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggCount", "type": "Object", + "tags": [], "label": "aggCount", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 214 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggCumulativeSum", "type": "Object", + "tags": [], "label": "aggCumulativeSum", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 215 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggDerivative", "type": "Object", + "tags": [], "label": "aggDerivative", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 216 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggGeoBounds", "type": "Object", + "tags": [], "label": "aggGeoBounds", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 217 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggGeoCentroid", "type": "Object", + "tags": [], "label": "aggGeoCentroid", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 218 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggMax", "type": "Object", + "tags": [], "label": "aggMax", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 219 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggMedian", "type": "Object", + "tags": [], "label": "aggMedian", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 220 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggSinglePercentile", "type": "Object", + "tags": [], "label": "aggSinglePercentile", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 221 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggMin", "type": "Object", + "tags": [], "label": "aggMin", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 222 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggMovingAvg", "type": "Object", + "tags": [], "label": "aggMovingAvg", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 223 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggPercentileRanks", "type": "Object", + "tags": [], "label": "aggPercentileRanks", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 224 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggPercentiles", "type": "Object", + "tags": [], "label": "aggPercentiles", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 225 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggSerialDiff", "type": "Object", + "tags": [], "label": "aggSerialDiff", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 226 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggStdDeviation", "type": "Object", + "tags": [], "label": "aggStdDeviation", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 227 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggSum", "type": "Object", + "tags": [], "label": "aggSum", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 228 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggTopHit", "type": "Object", + "tags": [], "label": "aggTopHit", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 229 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 195 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.AggParamOption", "type": "Interface", + "tags": [], "label": "AggParamOption", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggParamOption.val", "type": "string", + "tags": [], "label": "val", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggParamOption.display", "type": "string", + "tags": [], "label": "display", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.AggParamOption.enabled", "type": "Function", + "tags": [], "label": "enabled", + "description": [], "signature": [ "((agg: ", { @@ -8161,13 +9185,19 @@ }, ") => boolean) | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.AggParamOption.enabled.$1", "type": "Object", + "tags": [], "label": "agg", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -8177,44 +9207,39 @@ "text": "AggConfig" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_params.ts", - "lineNumber": 33 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_params.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ApplyGlobalFilterActionContext", "type": "Interface", + "tags": [], "label": "ApplyGlobalFilterActionContext", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.ApplyGlobalFilterActionContext.filters", "type": "Array", + "tags": [], "label": "filters", "description": [], - "source": { - "path": "src/plugins/data/public/actions/apply_filter_action.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "data", @@ -8224,62 +9249,70 @@ "text": "Filter" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ApplyGlobalFilterActionContext.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/public/actions/apply_filter_action.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ApplyGlobalFilterActionContext.embeddable", "type": "Unknown", + "tags": [], "label": "embeddable", "description": [], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/data/public/actions/apply_filter_action.ts", "lineNumber": 23 }, - "signature": [ - "unknown" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/actions/apply_filter_action.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.DataPublicPluginStartActions", "type": "Interface", + "tags": [], "label": "DataPublicPluginStartActions", "description": [ "\nutilities to generate filters from action context" ], - "tags": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStartActions.createFiltersFromValueClickAction", "type": "Function", + "tags": [], "label": "createFiltersFromValueClickAction", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 68 - }, "signature": [ "({ data, negate, }: ", "ValueClickDataContext", @@ -8292,49 +9325,55 @@ "text": "Filter" }, "[]>" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 60 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStartActions.createFiltersFromRangeSelectAction", "type": "Function", + "tags": [], "label": "createFiltersFromRangeSelectAction", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 69 - }, "signature": [ "typeof ", "createFiltersFromRangeSelectAction" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 61 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 67 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.DataPublicPluginStartUi", "type": "Interface", + "tags": [], "label": "DataPublicPluginStartUi", "description": [ "\nData plugin prewired UI components" ], - "tags": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStartUi.IndexPatternSelect", "type": "CompoundType", + "tags": [], "label": "IndexPatternSelect", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 60 - }, "signature": [ "React.ComponentType<", { @@ -8345,18 +9384,20 @@ "text": "IndexPatternSelectProps" }, ">" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 52 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStartUi.SearchBar", "type": "CompoundType", + "tags": [], "label": "SearchBar", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 61 - }, "signature": [ "React.ComponentType<", { @@ -8367,136 +9408,158 @@ "text": "StatefulSearchBarProps" }, ">" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 53 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 59 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.EsQueryConfig", "type": "Interface", + "tags": [], "label": "EsQueryConfig", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.EsQueryConfig.allowLeadingWildcards", "type": "boolean", + "tags": [], "label": "allowLeadingWildcards", "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.EsQueryConfig.queryStringOptions", "type": "Object", + "tags": [], "label": "queryStringOptions", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 19 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.EsQueryConfig.ignoreFilterIfFieldNotInIndex", "type": "boolean", + "tags": [], "label": "ignoreFilterIfFieldNotInIndex", "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.EsQueryConfig.dateFormatTZ", "type": "string", + "tags": [], "label": "dateFormatTZ", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.FieldFormatConfig", "type": "Interface", + "tags": [], "label": "FieldFormatConfig", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.FieldFormatConfig.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 63 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.FieldFormatConfig.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 64 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.FieldFormatConfig.es", "type": "CompoundType", + "tags": [], "label": "es", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 65 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 62 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IDataPluginServices", "type": "Interface", + "tags": [], "label": "IDataPluginServices", + "description": [], "signature": [ { "pluginId": "data", @@ -8515,30 +9578,32 @@ }, ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 107 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IDataPluginServices.appName", "type": "string", + "tags": [], "label": "appName", "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 116 - } + "lineNumber": 108 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IDataPluginServices.uiSettings", "type": "Object", + "tags": [], "label": "uiSettings", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 117 - }, "signature": [ { "pluginId": "core", @@ -8547,18 +9612,20 @@ "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 109 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IDataPluginServices.savedObjects", "type": "Object", + "tags": [], "label": "savedObjects", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 118 - }, "signature": [ { "pluginId": "core", @@ -8567,18 +9634,20 @@ "section": "def-public.SavedObjectsStart", "text": "SavedObjectsStart" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 110 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IDataPluginServices.notifications", "type": "Object", + "tags": [], "label": "notifications", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 119 - }, "signature": [ { "pluginId": "core", @@ -8587,18 +9656,20 @@ "section": "def-public.NotificationsStart", "text": "NotificationsStart" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 111 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IDataPluginServices.http", "type": "Object", + "tags": [], "label": "http", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 120 - }, "signature": [ { "pluginId": "core", @@ -8607,18 +9678,20 @@ "section": "def-public.HttpSetup", "text": "HttpSetup" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 112 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IDataPluginServices.storage", "type": "Object", + "tags": [], "label": "storage", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 121 - }, "signature": [ { "pluginId": "kibanaUtils", @@ -8628,18 +9701,20 @@ "text": "IStorageWrapper" }, "" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IDataPluginServices.data", "type": "Object", + "tags": [], "label": "data", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 122 - }, "signature": [ { "pluginId": "data", @@ -8648,18 +9723,20 @@ "section": "def-public.DataPublicPluginStart", "text": "DataPublicPluginStart" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 114 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IDataPluginServices.usageCollection", "type": "Object", + "tags": [], "label": "usageCollection", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 123 - }, "signature": [ { "pluginId": "usageCollection", @@ -8669,19 +9746,23 @@ "text": "UsageCollectionStart" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 115 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 115 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IEsSearchRequest", "type": "Interface", + "tags": [], "label": "IEsSearchRequest", + "description": [], "signature": [ { "pluginId": "data", @@ -8708,265 +9789,301 @@ }, ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IEsSearchRequest.indexType", "type": "string", + "tags": [], "label": "indexType", "description": [], + "signature": [ + "string | undefined" + ], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IFieldSubType", "type": "Interface", + "tags": [], "label": "IFieldSubType", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 153 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldSubType.multi", "type": "Object", + "tags": [], "label": "multi", "description": [], + "signature": [ + "{ parent: string; } | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 154 }, - "signature": [ - "{ parent: string; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldSubType.nested", "type": "Object", + "tags": [], "label": "nested", "description": [], + "signature": [ + "{ path: string; } | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 155 }, - "signature": [ - "{ path: string; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 153 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IFieldType", "type": "Interface", + "tags": [], "label": "IFieldType", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.script", "type": "string", + "tags": [], "label": "script", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 14 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.lang", "type": "string", + "tags": [], "label": "lang", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 15 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.count", "type": "number", + "tags": [], "label": "count", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 16 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.esTypes", "type": "Array", + "tags": [], "label": "esTypes", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 19 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.aggregatable", "type": "CompoundType", + "tags": [], "label": "aggregatable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 20 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.filterable", "type": "CompoundType", + "tags": [], "label": "filterable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 21 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.searchable", "type": "CompoundType", + "tags": [], "label": "searchable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 22 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.sortable", "type": "CompoundType", + "tags": [], "label": "sortable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 23 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.visualizable", "type": "CompoundType", + "tags": [], "label": "visualizable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 24 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.readFromDocValues", "type": "CompoundType", + "tags": [], "label": "readFromDocValues", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 25 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.scripted", "type": "CompoundType", + "tags": [], "label": "scripted", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 26 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.subType", "type": "Object", + "tags": [], "label": "subType", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "lineNumber": 27 - }, "signature": [ { "pluginId": "data", @@ -8976,60 +10093,68 @@ "text": "IFieldSubType" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 27 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 28 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.customLabel", "type": "string", + "tags": [], "label": "customLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 29 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.format", "type": "Any", + "tags": [], "label": "format", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 30 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IFieldType.toSpec", "type": "Function", + "tags": [], "label": "toSpec", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "lineNumber": 31 - }, "signature": [ "((options?: { getFormatterForField?: ((field: ", { @@ -9071,34 +10196,38 @@ "section": "def-common.FieldSpec", "text": "FieldSpec" } - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 31 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IIndexPattern", "type": "Interface", + "tags": [], "label": "IIndexPattern", "description": [ "\nIIndexPattern allows for an IndexPattern OR an index pattern saved object\ntoo ambiguous, should be avoided" ], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IIndexPattern.fields", "type": "Array", + "tags": [], "label": "fields", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 32 - }, "signature": [ { "pluginId": "data", @@ -9108,67 +10237,83 @@ "text": "IFieldType" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 32 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IIndexPattern.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IIndexPattern.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 34 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IIndexPattern.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nType is used for identifying rollup indices, otherwise left undefined" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 38 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IIndexPattern.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 39 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.IIndexPattern.getTimeField", "type": "Function", + "tags": [], "label": "getTimeField", + "description": [], "signature": [ "(() => ", { @@ -9180,25 +10325,21 @@ }, " | undefined) | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 40 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IIndexPattern.fieldFormatMap", "type": "Object", + "tags": [], "label": "fieldFormatMap", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 41 - }, "signature": [ "Record | undefined> | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 41 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IIndexPattern.getFormatterForField", "type": "Function", + "tags": [], "label": "getFormatterForField", "description": [ "\nLook up a formatter for a given field" ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 45 - }, "signature": [ "((field: ", { @@ -9257,19 +10400,23 @@ "text": "FieldFormat" }, ") | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 45 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList", "type": "Interface", + "tags": [], "label": "IIndexPatternFieldList", + "description": [], "signature": [ { "pluginId": "data", @@ -9288,13 +10435,19 @@ }, "[]" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.add", "type": "Function", + "tags": [], "label": "add", + "description": [], "signature": [ "(field: ", { @@ -9306,13 +10459,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.add.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -9322,24 +10481,23 @@ "text": "FieldSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 18 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.getAll", "type": "Function", + "tags": [], "label": "getAll", + "description": [], "signature": [ "() => ", { @@ -9351,19 +10509,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.getByName", "type": "Function", + "tags": [], "label": "getByName", + "description": [], "signature": [ "(name: string) => ", { @@ -9375,34 +10535,39 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.getByName.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 20 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.getByType", "type": "Function", + "tags": [], "label": "getByType", + "description": [], "signature": [ "(type: string) => ", { @@ -9414,34 +10579,39 @@ }, "[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.getByType.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 21 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.remove", "type": "Function", + "tags": [], "label": "remove", + "description": [], "signature": [ "(field: ", { @@ -9453,13 +10623,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.remove.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -9469,40 +10645,41 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 22 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.removeAll", "type": "Function", + "tags": [], "label": "removeAll", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.replaceAll", "type": "Function", + "tags": [], "label": "replaceAll", + "description": [], "signature": [ "(specs: ", { @@ -9514,13 +10691,19 @@ }, "[]) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.replaceAll.$1", "type": "Array", + "tags": [], "label": "specs", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -9531,24 +10714,23 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 24 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.update", "type": "Function", + "tags": [], "label": "update", + "description": [], "signature": [ "(field: ", { @@ -9560,13 +10742,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.update.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -9576,24 +10764,23 @@ "text": "FieldSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 25 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.toSpec", "type": "Function", + "tags": [], "label": "toSpec", + "description": [], "signature": [ "(options?: { getFormatterForField?: ((field: ", { @@ -9636,25 +10823,32 @@ "text": "FieldSpec" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.toSpec.$1.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IIndexPatternFieldList.toSpec.$1.options.getFormatterForField", "type": "Function", + "tags": [], "label": "getFormatterForField", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 27 - }, "signature": [ "((field: ", { @@ -9689,33 +10883,28 @@ "text": "FieldFormat" }, ") | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 27 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 26 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 26 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IKibanaSearchRequest", "type": "Interface", + "tags": [], "label": "IKibanaSearchRequest", + "description": [], "signature": [ { "pluginId": "data", @@ -9726,50 +10915,56 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { - "tags": [], + "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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 78 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IKibanaSearchRequest.params", "type": "Uncategorized", + "tags": [], "label": "params", "description": [], + "signature": [ + "Params | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 80 }, - "signature": [ - "Params | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 74 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IKibanaSearchResponse", "type": "Interface", + "tags": [], "label": "IKibanaSearchResponse", + "description": [], "signature": [ { "pluginId": "data", @@ -9780,367 +10975,416 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 44 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IKibanaSearchResponse.total", "type": "number", + "tags": [], "label": "total", "description": [ "\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 50 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IKibanaSearchResponse.loaded", "type": "number", + "tags": [], "label": "loaded", "description": [ "\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 56 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IKibanaSearchResponse.isRunning", "type": "CompoundType", + "tags": [], "label": "isRunning", "description": [ "\nIndicates whether search is still in flight" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 61 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IKibanaSearchResponse.isPartial", "type": "CompoundType", + "tags": [], "label": "isPartial", "description": [ "\nIndicates whether the results returned are complete or partial" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 66 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IKibanaSearchResponse.rawResponse", "type": "Uncategorized", + "tags": [], "label": "rawResponse", "description": [ "\nThe raw response returned by the internal search method (usually the raw ES response)" ], + "signature": [ + "RawResponse" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 71 }, - "signature": [ - "RawResponse" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 40 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes", "type": "Interface", + "tags": [], "label": "IndexPatternAttributes", "description": [ "\nInterface for an index pattern saved object" ], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 54 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.fields", "type": "string", + "tags": [], "label": "fields", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 56 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.typeMeta", "type": "string", + "tags": [], "label": "typeMeta", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 58 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.intervalName", "type": "string", + "tags": [], "label": "intervalName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 59 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.sourceFilters", "type": "string", + "tags": [], "label": "sourceFilters", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 60 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.fieldFormatMap", "type": "string", + "tags": [], "label": "fieldFormatMap", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 61 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.fieldAttrs", "type": "string", + "tags": [], "label": "fieldAttrs", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 62 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.runtimeFieldMap", "type": "string", + "tags": [], "label": "runtimeFieldMap", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 63 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternAttributes.allowNoIndex", "type": "CompoundType", + "tags": [], "label": "allowNoIndex", "description": [ "\nprevents errors when index pattern exists before indices" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 67 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternSpec", "type": "Interface", + "tags": [], "label": "IndexPatternSpec", "description": [ "\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state" ], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 224 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nsaved object id" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 228 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.version", "type": "string", + "tags": [], "label": "version", "description": [ "\nsaved object version string" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 232 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.title", "type": "string", + "tags": [], "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 233 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-public.IndexPatternSpec.intervalName", + "type": "string", "tags": [ "deprecated" ], - "id": "def-public.IndexPatternSpec.intervalName", - "type": "string", "label": "intervalName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 238 }, - "signature": [ - "string | undefined" - ] + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 239 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.sourceFilters", "type": "Array", + "tags": [], "label": "sourceFilters", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 240 - }, "signature": [ { "pluginId": "data", @@ -10150,18 +11394,20 @@ "text": "SourceFilter" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 240 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.fields", "type": "Object", + "tags": [], "label": "fields", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 241 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 241 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.typeMeta", "type": "Object", + "tags": [], "label": "typeMeta", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 242 - }, "signature": [ { "pluginId": "data", @@ -10193,32 +11441,36 @@ "text": "TypeMeta" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 242 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 243 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.fieldFormats", "type": "Object", + "tags": [], "label": "fieldFormats", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 244 - }, "signature": [ "Record>> | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 244 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.runtimeFieldMap", "type": "Object", + "tags": [], "label": "runtimeFieldMap", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 245 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 245 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.fieldAttrs", "type": "Object", + "tags": [], "label": "fieldAttrs", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 246 - }, "signature": [ { "pluginId": "data", @@ -10272,144 +11528,162 @@ "text": "FieldAttrs" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 246 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.IndexPatternSpec.allowNoIndex", "type": "CompoundType", + "tags": [], "label": "allowNoIndex", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 247 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 224 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ISearchOptions", "type": "Interface", + "tags": [], "label": "ISearchOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 90 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchOptions.abortSignal", "type": "Object", + "tags": [], "label": "abortSignal", "description": [ "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." ], + "signature": [ + "AbortSignal | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 87 + "lineNumber": 94 }, - "signature": [ - "AbortSignal | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 92 + "lineNumber": 99 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 98 + "lineNumber": 105 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchOptions.sessionId", "type": "string", + "tags": [], "label": "sessionId", "description": [ "\nA session ID, grouping multiple search requests into a single session." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 103 + "lineNumber": 110 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchOptions.isStored", "type": "CompoundType", + "tags": [], "label": "isStored", "description": [ "\nWhether the session is already saved (i.e. sent to background)" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 108 + "lineNumber": 115 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 114 + "lineNumber": 121 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchOptions.indexPattern", "type": "Object", + "tags": [], "label": "indexPattern", "description": [ "\nIndex pattern reference is used for better error messages" ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 120 - }, "signature": [ { "pluginId": "data", @@ -10419,38 +11693,65 @@ "text": "IndexPattern" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 126 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.ISearchOptions.inspector", + "type": "Object", + "tags": [], + "label": "inspector", + "description": [ + "\nInspector integration options" + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IInspectorInfo", + "text": "IInspectorInfo" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 131 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 83 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ISearchStartSearchSource", "type": "Interface", + "tags": [], "label": "ISearchStartSearchSource", "description": [ "\nhigh level search service" ], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchStartSearchSource.create", "type": "Function", + "tags": [], "label": "create", "description": [ "\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 30 - }, "signature": [ "(fields?: ", { @@ -10469,20 +11770,22 @@ "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">>" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 31 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchStartSearchSource.createEmpty", "type": "Function", + "tags": [], "label": "createEmpty", "description": [ "\ncreates empty {@link SearchSource}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 34 - }, "signature": [ "() => Pick<", { @@ -10493,110 +11796,126 @@ "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 35 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.KueryNode", "type": "Interface", + "tags": [], "label": "KueryNode", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.KueryNode.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 12 }, - "signature": [ - "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.KueryNode.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 13 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/kuery/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.OptionedValueProp", "type": "Interface", + "tags": [], "label": "OptionedValueProp", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.OptionedValueProp.value", "type": "string", + "tags": [], "label": "value", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.OptionedValueProp.text", "type": "string", + "tags": [], "label": "text", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.OptionedValueProp.disabled", "type": "CompoundType", + "tags": [], "label": "disabled", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 15 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.OptionedValueProp.isCompatible", "type": "Function", + "tags": [], "label": "isCompatible", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 16 - }, "signature": [ "(agg: ", { @@ -10607,278 +11926,320 @@ "text": "AggConfig" }, ") => boolean" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.RangeFilterParams", "type": "Interface", + "tags": [], "label": "RangeFilterParams", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.RangeFilterParams.from", "type": "CompoundType", + "tags": [], "label": "from", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 36 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.RangeFilterParams.to", "type": "CompoundType", + "tags": [], "label": "to", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 37 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.RangeFilterParams.gt", "type": "CompoundType", + "tags": [], "label": "gt", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 38 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.RangeFilterParams.lt", "type": "CompoundType", + "tags": [], "label": "lt", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 39 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.RangeFilterParams.gte", "type": "CompoundType", + "tags": [], "label": "gte", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 40 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.RangeFilterParams.lte", "type": "CompoundType", + "tags": [], "label": "lte", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 41 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.RangeFilterParams.format", "type": "string", + "tags": [], "label": "format", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 42 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.RefreshInterval", "type": "Interface", + "tags": [], "label": "RefreshInterval", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.RefreshInterval.pause", "type": "boolean", + "tags": [], "label": "pause", "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.RefreshInterval.value", "type": "number", + "tags": [], "label": "value", "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 13 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/query/timefilter/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SearchError", "type": "Interface", + "tags": [], "label": "SearchError", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchError.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 40 - } + "lineNumber": 31 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchError.status", "type": "string", + "tags": [], "label": "status", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 41 - } + "lineNumber": 32 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchError.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 42 - } + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchError.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 43 - } + "lineNumber": 34 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchError.path", "type": "string", + "tags": [], "label": "path", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 44 - } + "lineNumber": 35 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchError.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 45 - } + "lineNumber": 36 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 39 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SearchSourceFields", "type": "Interface", + "tags": [], "label": "SearchSourceFields", "description": [ "\nsearch source fields" ], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 62 + "lineNumber": 71 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.query", "type": "Object", + "tags": [], "label": "query", "description": [ "\n{@link Query}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 66 - }, "signature": [ { "pluginId": "data", @@ -10888,20 +12249,22 @@ "text": "Query" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 75 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.filter", "type": "CompoundType", + "tags": [], "label": "filter", "description": [ "\n{@link Filter}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 70 - }, "signature": [ { "pluginId": "data", @@ -10935,20 +12298,22 @@ "text": "Filter" }, "[] | undefined) | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 79 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.sort", "type": "CompoundType", + "tags": [], "label": "sort", "description": [ "\n{@link EsQuerySortValue}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 74 - }, "signature": [ "Record | Record[] | undefined" - ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 83 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.highlight", "type": "Any", + "tags": [], "label": "highlight", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 75 + "lineNumber": 84 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.highlightAll", "type": "CompoundType", + "tags": [], "label": "highlightAll", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 76 + "lineNumber": 85 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.trackTotalHits", "type": "CompoundType", + "tags": [], "label": "trackTotalHits", "description": [], + "signature": [ + "number | boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 77 + "lineNumber": 86 }, - "signature": [ - "number | boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.aggs", - "type": "Any", + "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" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 81 + "lineNumber": 90 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.from", "type": "number", + "tags": [], "label": "from", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 82 + "lineNumber": 91 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.size", "type": "number", + "tags": [], "label": "size", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 83 + "lineNumber": 92 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.source", "type": "CompoundType", + "tags": [], "label": "source", "description": [], + "signature": [ + "string | boolean | string[] | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 84 + "lineNumber": 93 }, - "signature": [ - "string | boolean | string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.version", "type": "CompoundType", + "tags": [], "label": "version", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 85 + "lineNumber": 94 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.fields", "type": "Array", + "tags": [], "label": "fields", "description": [ "\nRetrieve fields via the search Fields API" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 89 - }, "signature": [ { "pluginId": "data", @@ -11120,38 +12518,58 @@ "text": "SearchFieldValue" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 98 + }, + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.fieldsFromSource", + "type": "CompoundType", "tags": [ "deprecated" ], - "id": "def-public.SearchSourceFields.fieldsFromSource", - "type": "CompoundType", "label": "fieldsFromSource", "description": [ "\nRetreive fields directly from _source (legacy behavior)\n" ], + "signature": [ + "string | boolean | string[] | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 95 + "lineNumber": 104 }, - "signature": [ - "string | boolean | string[] | undefined" + "deprecated": true, + "references": [ + { + "plugin": "reporting", + "link": { + "path": "x-pack/plugins/reporting/server/export_types/csv_searchsource/generate_csv/generate_csv.ts", + "lineNumber": 150 + } + }, + { + "plugin": "reporting", + "link": { + "path": "x-pack/plugins/reporting/server/export_types/csv_searchsource/generate_csv/generate_csv.ts", + "lineNumber": 152 + } + } ] }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.index", "type": "Object", + "tags": [], "label": "index", "description": [ "\n{@link IndexPatternService}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 99 - }, "signature": [ { "pluginId": "data", @@ -11161,18 +12579,20 @@ "text": "IndexPattern" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 108 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.searchAfter", "type": "Object", + "tags": [], "label": "searchAfter", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 100 - }, "signature": [ { "pluginId": "data", @@ -11182,46 +12602,52 @@ "text": "EsQuerySearchAfter" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 109 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.timeout", "type": "string", + "tags": [], "label": "timeout", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 101 + "lineNumber": 110 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.terminate_after", "type": "number", + "tags": [], "label": "terminate_after", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 102 + "lineNumber": 111 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSourceFields.parent", "type": "Object", + "tags": [], "label": "parent", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 104 - }, "signature": [ { "pluginId": "data", @@ -11231,214 +12657,232 @@ "text": "SearchSourceFields" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 113 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 61 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.TypeMeta", "type": "Interface", + "tags": [], "label": "TypeMeta", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 158 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.TypeMeta.aggs", "type": "Object", + "tags": [], "label": "aggs", "description": [], + "signature": [ + "Record> | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 159 }, - "signature": [ - "Record> | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.TypeMeta.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 160 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 158 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "data", "id": "def-public.BUCKET_TYPES", "type": "Enum", - "label": "BUCKET_TYPES", "tags": [], + "label": "BUCKET_TYPES", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", "lineNumber": 9 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ES_FIELD_TYPES", "type": "Enum", + "tags": [], "label": "ES_FIELD_TYPES", - "tags": [ - "public" - ], "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", "lineNumber": 18 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.KBN_FIELD_TYPES", "type": "Enum", + "tags": [], "label": "KBN_FIELD_TYPES", - "tags": [ - "public" - ], "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", "lineNumber": 64 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.METRIC_TYPES", "type": "Enum", - "label": "METRIC_TYPES", "tags": [], + "label": "METRIC_TYPES", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", "lineNumber": 9 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SortDirection", "type": "Enum", - "label": "SortDirection", "tags": [], + "label": "SortDirection", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 39 + "lineNumber": 40 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.ACTION_GLOBAL_APPLY_FILTER", "type": "string", + "tags": [], "label": "ACTION_GLOBAL_APPLY_FILTER", "description": [], + "signature": [ + "\"ACTION_GLOBAL_APPLY_FILTER\"" + ], "source": { "path": "src/plugins/data/public/actions/apply_filter_action.ts", "lineNumber": 16 }, - "signature": [ - "\"ACTION_GLOBAL_APPLY_FILTER\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.AggConfigOptions", "type": "Type", - "label": "AggConfigOptions", "tags": [], + "label": "AggConfigOptions", "description": [], + "signature": [ + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 43 }, - "signature": [ - "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.AggGroupName", "type": "Type", - "label": "AggGroupName", "tags": [], + "label": "AggGroupName", "description": [], + "signature": [ + "\"buckets\" | \"metrics\" | \"none\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 18 }, - "signature": [ - "\"buckets\" | \"metrics\" | \"none\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.AggParam", "type": "Type", - "label": "AggParam", "tags": [], + "label": "AggParam", "description": [], + "signature": [ + "BaseParamType" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 28 }, - "signature": [ - "BaseParamType" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.AggregationRestrictions", "type": "Type", - "label": "AggregationRestrictions", "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; }; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 141 }, - "signature": [ - "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.AggsStart", "type": "Type", + "tags": [], "label": "AggsStart", - "tags": [ - "public" - ], "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" ], - "source": { - "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 129 - }, "signature": [ "{ calculateAutoTimeExpression: (range: ", { @@ -11468,63 +12912,71 @@ }, "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }" ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 129 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.APPLY_FILTER_TRIGGER", "type": "string", + "tags": [], "label": "APPLY_FILTER_TRIGGER", "description": [], + "signature": [ + "\"FILTER_TRIGGER\"" + ], "source": { "path": "src/plugins/data/public/triggers/apply_filter_trigger.ts", "lineNumber": 12 }, - "signature": [ - "\"FILTER_TRIGGER\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.CustomFilter", "type": "Type", - "label": "CustomFilter", "tags": [], + "label": "CustomFilter", "description": [], + "signature": [ + "Filter & { query: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/custom_filter.ts", "lineNumber": 11 }, - "signature": [ - "Filter & { query: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ES_SEARCH_STRATEGY", "type": "string", + "tags": [], "label": "ES_SEARCH_STRATEGY", "description": [], - "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", - "lineNumber": 12 - }, "signature": [ "\"es\"" ], + "source": { + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "lineNumber": 12 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.EsaggsExpressionFunctionDefinition", "type": "Type", - "label": "EsaggsExpressionFunctionDefinition", "tags": [], + "label": "EsaggsExpressionFunctionDefinition", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", - "lineNumber": 35 - }, "signature": [ "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", { @@ -11546,18 +12998,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", + "lineNumber": 35 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.EsdslExpressionFunctionDefinition", "type": "Type", - "label": "EsdslExpressionFunctionDefinition", "tags": [], + "label": "EsdslExpressionFunctionDefinition", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/esdsl.ts", - "lineNumber": 29 - }, "signature": [ "ExpressionFunctionDefinition<\"esdsl\", ", { @@ -11594,78 +13048,88 @@ ", ", "SerializableState" ], + "source": { + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 29 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.EsQuerySortValue", "type": "Type", - "label": "EsQuerySortValue", "tags": [], + "label": "EsQuerySortValue", "description": [], + "signature": [ + "{ [x: string]: SortDirection | SortDirectionNumeric | SortDirectionFormat; }" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 49 + "lineNumber": 55 }, - "signature": [ - "{ [x: string]: SortDirection | SortDirectionNumeric; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.EsRawResponseExpressionTypeDefinition", "type": "Type", - "label": "EsRawResponseExpressionTypeDefinition", "tags": [], + "label": "EsRawResponseExpressionTypeDefinition", "description": [], + "signature": [ + "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" + ], "source": { "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "lineNumber": 57 }, - "signature": [ - "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ExecutionContextSearch", "type": "Type", - "label": "ExecutionContextSearch", "tags": [], + "label": "ExecutionContextSearch", "description": [], + "signature": [ + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 15 }, - "signature": [ - "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ExistsFilter", "type": "Type", - "label": "ExistsFilter", "tags": [], + "label": "ExistsFilter", "description": [], + "signature": [ + "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", "lineNumber": 18 }, - "signature": [ - "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ExpressionFunctionKibana", "type": "Type", - "label": "ExpressionFunctionKibana", "tags": [], + "label": "ExpressionFunctionKibana", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kibana.ts", - "lineNumber": 17 - }, "signature": [ "ExpressionFunctionDefinition<\"kibana\", ", { @@ -11685,18 +13149,20 @@ }, "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" ], - "initialIsOpen": false - }, + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 17 + }, + "deprecated": false, + "initialIsOpen": false + }, { + "parentPluginId": "data", "id": "def-public.ExpressionFunctionKibanaContext", "type": "Type", - "label": "ExpressionFunctionKibanaContext", "tags": [], + "label": "ExpressionFunctionKibanaContext", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_context.ts", - "lineNumber": 34 - }, "signature": [ "ExpressionFunctionDefinition<\"kibana_context\", ", { @@ -11716,160 +13182,178 @@ }, "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" ], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 34 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ExpressionValueSearchContext", "type": "Type", - "label": "ExpressionValueSearchContext", "tags": [], + "label": "ExpressionValueSearchContext", "description": [], + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 21 }, - "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.FieldFormatId", "type": "Type", - "label": "FieldFormatId", "tags": [ "string" ], + "label": "FieldFormatId", "description": [], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 75 }, - "signature": [ - "string" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.FieldFormatsContentType", "type": "Type", + "tags": [], "label": "FieldFormatsContentType", - "tags": [ - "public" - ], "description": [], + "signature": [ + "\"html\" | \"text\"" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 14 }, - "signature": [ - "\"html\" | \"text\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.FieldFormatsGetConfigFn", "type": "Type", - "label": "FieldFormatsGetConfigFn", "tags": [], + "label": "FieldFormatsGetConfigFn", "description": [], + "signature": [ + "(key: string, defaultOverride: T | undefined) => T" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 68 }, - "signature": [ - "(key: string, defaultOverride: T | undefined) => T" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.Filter", "type": "Type", - "label": "Filter", "tags": [], + "label": "Filter", "description": [], + "signature": [ + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 41 }, - "signature": [ - "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IAggConfig", "type": "Type", - "label": "IAggConfig", "tags": [ "name", "description" ], + "label": "IAggConfig", "description": [], + "signature": [ + "AggConfig" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 53 }, - "signature": [ - "AggConfig" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IAggType", "type": "Type", - "label": "IAggType", "tags": [], + "label": "IAggType", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 59 - }, "signature": [ "AggType>" ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 62 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IEsSearchResponse", "type": "Type", - "label": "IEsSearchResponse", "tags": [], + "label": "IEsSearchResponse", "description": [], - "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", - "lineNumber": 22 - }, "signature": [ "IKibanaSearchResponse>" ], + "source": { + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "lineNumber": 22 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IFieldFormat", "type": "Type", - "label": "IFieldFormat", "tags": [], + "label": "IFieldFormat", "description": [], + "signature": [ + "FieldFormat" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 70 }, - "signature": [ - "FieldFormat" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IFieldFormatsRegistry", "type": "Type", - "label": "IFieldFormatsRegistry", "tags": [], + "label": "IFieldFormatsRegistry", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/index.ts", - "lineNumber": 11 - }, "signature": [ "{ init: (getConfig: ", { @@ -11894,48 +13378,54 @@ "text": "KBN_FIELD_TYPES" } ], + "source": { + "path": "src/plugins/data/common/field_formats/index.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IFieldParamType", "type": "Type", - "label": "IFieldParamType", "tags": [], + "label": "IFieldParamType", "description": [], + "signature": [ + "FieldParamType" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 24 }, - "signature": [ - "FieldParamType" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IMetricAggType", "type": "Type", - "label": "IMetricAggType", "tags": [], + "label": "IMetricAggType", "description": [], + "signature": [ + "MetricAggType" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 35 }, - "signature": [ - "MetricAggType" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternLoadExpressionFunctionDefinition", "type": "Type", - "label": "IndexPatternLoadExpressionFunctionDefinition", "tags": [], + "label": "IndexPatternLoadExpressionFunctionDefinition", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", - "lineNumber": 35 - }, "signature": [ "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", { @@ -11957,33 +13447,37 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 35 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IndexPatternsContract", "type": "Type", - "label": "IndexPatternsContract", "tags": [], + "label": "IndexPatternsContract", "description": [], + "signature": [ + "{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; find: (search: string, size?: number) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise[] | null | undefined>; getDefault: () => Promise; setDefault: (id: string, force?: boolean) => Promise; getFieldsForWildcard: (options: GetFieldsOptions) => Promise; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise; refreshFields: (indexPattern: IndexPattern) => Promise; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record; savedObjectToSpec: (savedObject: SavedObject) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 642 }, - "signature": [ - "{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; find: (search: string, size?: number) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise[] | null | undefined>; getDefault: () => Promise; setDefault: (id: string, force?: boolean) => Promise; getFieldsForWildcard: (options: GetFieldsOptions) => Promise; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise; refreshFields: (indexPattern: IndexPattern) => Promise; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record; savedObjectToSpec: (savedObject: SavedObject) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ISearchGeneric", "type": "Type", - "label": "ISearchGeneric", "tags": [], + "label": "ISearchGeneric", "description": [], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 13 - }, "signature": [ "(request: SearchStrategyRequest, options: ", { @@ -11997,294 +13491,342 @@ "Observable", "" ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ISearchSource", "type": "Type", + "tags": [], "label": "ISearchSource", - "tags": [ - "public" - ], "description": [ "\nsearch source interface" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 19 - }, "signature": [ "{ create: () => SearchSource; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: SearchSourceFields[K]) => SearchSource; removeField: (field: K) => SearchSource; setFields: (newFields: SearchSourceFields) => SearchSource; getId: () => string; getFields: () => SearchSourceFields; getField: (field: K, recurse?: boolean) => SearchSourceFields[K]; getOwnField: (field: K) => SearchSourceFields[K]; createCopy: () => SearchSource; createChild: (options?: {}) => SearchSource; setParent: (parent?: Pick | undefined, options?: SearchSourceOptions) => SearchSource; getParent: () => SearchSource | undefined; fetch$: (options?: ", { "pluginId": "data", - "scope": "common", + "scope": "public", "docId": "kibDataPluginApi", - "section": "def-common.ISearchOptions", + "section": "def-public.ISearchOptions", "text": "ISearchOptions" }, ") => ", "Observable", "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", "SearchResponse", - ">; fetch: (options?: ", + ">>; fetch: (options?: ", { "pluginId": "data", - "scope": "common", + "scope": "public", "docId": "kibDataPluginApi", - "section": "def-common.ISearchOptions", + "section": "def-public.ISearchOptions", "text": "ISearchOptions" - }, - ") => Promise<", - "SearchResponse" + } ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.KibanaContext", "type": "Type", - "label": "KibanaContext", "tags": [], + "label": "KibanaContext", "description": [], + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 32 }, - "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.MatchAllFilter", "type": "Type", - "label": "MatchAllFilter", "tags": [], + "label": "MatchAllFilter", "description": [], + "signature": [ + "Filter & { meta: MatchAllFilterMeta; match_all: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", "lineNumber": 16 }, - "signature": [ - "Filter & { meta: MatchAllFilterMeta; match_all: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ParsedInterval", "type": "Type", - "label": "ParsedInterval", "tags": [], + "label": "ParsedInterval", "description": [], + "signature": [ + "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", "lineNumber": 18 }, - "signature": [ - "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.PhraseFilter", "type": "Type", - "label": "PhraseFilter", "tags": [], + "label": "PhraseFilter", "description": [], + "signature": [ + "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 21 }, - "signature": [ - "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.PhrasesFilter", "type": "Type", - "label": "PhrasesFilter", "tags": [], + "label": "PhrasesFilter", "description": [], + "signature": [ + "Filter & { meta: PhrasesFilterMeta; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", "lineNumber": 19 }, - "signature": [ - "Filter & { meta: PhrasesFilterMeta; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.Query", "type": "Type", - "label": "Query", "tags": [], + "label": "Query", "description": [], + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], "source": { "path": "src/plugins/data/common/query/types.ts", "lineNumber": 12 }, - "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.RangeFilter", "type": "Type", - "label": "RangeFilter", "tags": [], + "label": "RangeFilter", "description": [], + "signature": [ + "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 60 }, - "signature": [ - "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.RangeFilterMeta", "type": "Type", - "label": "RangeFilterMeta", "tags": [], + "label": "RangeFilterMeta", "description": [], + "signature": [ + "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 50 }, - "signature": [ - "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.TimeRange", "type": "Type", - "label": "TimeRange", "tags": [], + "label": "TimeRange", "description": [], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 17 }, - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "data", "id": "def-public.AggGroupLabels", "type": "Object", "tags": [], + "label": "AggGroupLabels", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggGroupLabels.AggGroupNames.Buckets", "type": "string", + "tags": [], "label": "[AggGroupNames.Buckets]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggGroupLabels.AggGroupNames.Metrics", "type": "string", + "tags": [], "label": "[AggGroupNames.Metrics]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggGroupLabels.AggGroupNames.None", "type": "string", + "tags": [], "label": "[AggGroupNames.None]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 27 - } + }, + "deprecated": false } ], - "description": [], - "label": "AggGroupLabels", - "source": { - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggGroupNames", "type": "Object", + "tags": [], "label": "AggGroupNames", "description": [], + "signature": [ + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 12 }, - "signature": [ - "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.esFilters", "type": "Object", "tags": [], + "label": "esFilters", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.FilterLabel", "type": "Function", + "tags": [], "label": "FilterLabel", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 57 - }, "signature": [ "(props: ", "FilterLabelProps", ") => JSX.Element" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 57 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.FilterItem", "type": "Function", + "tags": [], "label": "FilterItem", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 58 - }, "signature": [ "(props: ", "FilterItemProps", ") => JSX.Element" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 58 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.FILTERS", "type": "Object", + "tags": [], "label": "FILTERS", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 60 - }, "signature": [ "typeof ", { @@ -12294,18 +13836,20 @@ "section": "def-common.FILTERS", "text": "FILTERS" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 60 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.FilterStateStore", "type": "Object", + "tags": [], "label": "FilterStateStore", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 61 - }, "signature": [ "typeof ", { @@ -12315,18 +13859,20 @@ "section": "def-common.FilterStateStore", "text": "FilterStateStore" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 61 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.buildEmptyFilter", "type": "Function", + "tags": [], "label": "buildEmptyFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 63 - }, "signature": [ "(isPinned: boolean, index?: string | undefined) => ", { @@ -12336,18 +13882,20 @@ "section": "def-common.Filter", "text": "Filter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 63 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.buildPhrasesFilter", "type": "Function", + "tags": [], "label": "buildPhrasesFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 64 - }, "signature": [ "(field: ", { @@ -12373,18 +13921,20 @@ "section": "def-common.PhrasesFilter", "text": "PhrasesFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 64 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.buildExistsFilter", "type": "Function", + "tags": [], "label": "buildExistsFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 65 - }, "signature": [ "(field: ", { @@ -12410,18 +13960,20 @@ "section": "def-common.ExistsFilter", "text": "ExistsFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 65 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.buildPhraseFilter", "type": "Function", + "tags": [], "label": "buildPhraseFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 66 - }, "signature": [ "(field: ", { @@ -12447,18 +13999,20 @@ "section": "def-common.PhraseFilter", "text": "PhraseFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 66 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.buildQueryFilter", "type": "Function", + "tags": [], "label": "buildQueryFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 67 - }, "signature": [ "(query: any, index: string, alias: string) => ", { @@ -12468,18 +14022,20 @@ "section": "def-common.QueryStringFilter", "text": "QueryStringFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 67 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.buildRangeFilter", "type": "Function", + "tags": [], "label": "buildRangeFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 68 - }, "signature": [ "(field: ", { @@ -12513,18 +14069,20 @@ "section": "def-common.RangeFilter", "text": "RangeFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 68 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.isPhraseFilter", "type": "Function", + "tags": [], "label": "isPhraseFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 70 - }, "signature": [ "(filter: any) => filter is ", { @@ -12534,18 +14092,20 @@ "section": "def-common.PhraseFilter", "text": "PhraseFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 70 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.isExistsFilter", "type": "Function", + "tags": [], "label": "isExistsFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 71 - }, "signature": [ "(filter: any) => filter is ", { @@ -12555,18 +14115,20 @@ "section": "def-common.ExistsFilter", "text": "ExistsFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 71 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.isPhrasesFilter", "type": "Function", + "tags": [], "label": "isPhrasesFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 72 - }, "signature": [ "(filter: any) => filter is ", { @@ -12576,18 +14138,20 @@ "section": "def-common.PhrasesFilter", "text": "PhrasesFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 72 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.isRangeFilter", "type": "Function", + "tags": [], "label": "isRangeFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 73 - }, "signature": [ "(filter: any) => filter is ", { @@ -12597,18 +14161,20 @@ "section": "def-common.RangeFilter", "text": "RangeFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 73 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.isMatchAllFilter", "type": "Function", + "tags": [], "label": "isMatchAllFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 74 - }, "signature": [ "(filter: any) => filter is ", { @@ -12618,18 +14184,20 @@ "section": "def-common.MatchAllFilter", "text": "MatchAllFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 74 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.isMissingFilter", "type": "Function", + "tags": [], "label": "isMissingFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 75 - }, "signature": [ "(filter: any) => filter is ", { @@ -12639,18 +14207,20 @@ "section": "def-common.MissingFilter", "text": "MissingFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 75 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.isQueryStringFilter", "type": "Function", + "tags": [], "label": "isQueryStringFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 76 - }, "signature": [ "(filter: any) => filter is ", { @@ -12660,18 +14230,20 @@ "section": "def-common.QueryStringFilter", "text": "QueryStringFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 76 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.isFilterPinned", "type": "Function", + "tags": [], "label": "isFilterPinned", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 77 - }, "signature": [ "(filter: ", { @@ -12682,18 +14254,20 @@ "text": "Filter" }, ") => boolean | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 77 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.toggleFilterNegated", "type": "Function", + "tags": [], "label": "toggleFilterNegated", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 79 - }, "signature": [ "(filter: ", { @@ -12712,18 +14286,20 @@ "text": "FilterState" }, " | undefined; query?: any; }" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 79 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.disableFilter", "type": "Function", + "tags": [], "label": "disableFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 80 - }, "signature": [ "(filter: ", { @@ -12741,18 +14317,20 @@ "section": "def-common.Filter", "text": "Filter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 80 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.getPhraseFilterField", "type": "Function", + "tags": [], "label": "getPhraseFilterField", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 81 - }, "signature": [ "(filter: ", { @@ -12763,18 +14341,20 @@ "text": "PhraseFilter" }, ") => string" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 81 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.getPhraseFilterValue", "type": "Function", + "tags": [], "label": "getPhraseFilterValue", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 82 - }, "signature": [ "(filter: ", { @@ -12785,18 +14365,20 @@ "text": "PhraseFilter" }, ") => PhraseFilterValue" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 82 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.getDisplayValueFromFilter", "type": "Function", + "tags": [], "label": "getDisplayValueFromFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 83 - }, "signature": [ "typeof ", { @@ -12806,18 +14388,20 @@ "section": "def-common.getDisplayValueFromFilter", "text": "getDisplayValueFromFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 83 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.compareFilters", "type": "Function", + "tags": [], "label": "compareFilters", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 85 - }, "signature": [ "(first: ", { @@ -12859,18 +14443,20 @@ "section": "def-common.FilterCompareOptions", "text": "FilterCompareOptions" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 85 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.COMPARE_ALL_OPTIONS", "type": "Object", + "tags": [], "label": "COMPARE_ALL_OPTIONS", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 86 - }, "signature": [ { "pluginId": "data", @@ -12879,33 +14465,37 @@ "section": "def-common.FilterCompareOptions", "text": "FilterCompareOptions" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 86 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.generateFilters", "type": "Function", + "tags": [], "label": "generateFilters", "description": [], + "signature": [ + "typeof ", + "generateFilters" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 87 }, - "signature": [ - "typeof ", - "generateFilters" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.onlyDisabledFiltersChanged", "type": "Function", + "tags": [], "label": "onlyDisabledFiltersChanged", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 88 - }, "signature": [ "(newFilters?: ", { @@ -12924,48 +14514,54 @@ "text": "Filter" }, "[] | undefined) => boolean" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 88 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.changeTimeFilter", "type": "Function", + "tags": [], "label": "changeTimeFilter", "description": [], + "signature": [ + "typeof ", + "changeTimeFilter" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 90 }, - "signature": [ - "typeof ", - "changeTimeFilter" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.convertRangeFilterToTimeRangeString", "type": "Function", + "tags": [], "label": "convertRangeFilterToTimeRangeString", "description": [], + "signature": [ + "typeof ", + "convertRangeFilterToTimeRangeString" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 91 }, - "signature": [ - "typeof ", - "convertRangeFilterToTimeRangeString" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.mapAndFlattenFilters", "type": "Function", + "tags": [], "label": "mapAndFlattenFilters", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 92 - }, "signature": [ "(filters: ", { @@ -12984,76 +14580,86 @@ "text": "Filter" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 92 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.extractTimeFilter", "type": "Function", + "tags": [], "label": "extractTimeFilter", "description": [], + "signature": [ + "typeof ", + "extractTimeFilter" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 93 }, - "signature": [ - "typeof ", - "extractTimeFilter" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esFilters.extractTimeRange", "type": "Function", + "tags": [], "label": "extractTimeRange", "description": [], + "signature": [ + "typeof ", + "extractTimeRange" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 94 }, - "signature": [ - "typeof ", - "extractTimeRange" - ] + "deprecated": false } ], - "description": [], - "label": "esFilters", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 56 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.esKuery", "type": "Object", "tags": [], + "label": "esKuery", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 123 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.esKuery.nodeTypes", "type": "Object", + "tags": [], "label": "nodeTypes", "description": [], + "signature": [ + "NodeTypes" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 124 }, - "signature": [ - "NodeTypes" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esKuery.fromKueryExpression", "type": "Function", + "tags": [], "label": "fromKueryExpression", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 125 - }, "signature": [ "(expression: any, parseOptions?: Partial<", { @@ -13071,18 +14677,20 @@ "section": "def-common.KueryNode", "text": "KueryNode" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 125 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esKuery.toElasticsearchQuery", "type": "Function", + "tags": [], "label": "toElasticsearchQuery", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 126 - }, "signature": [ "(node: ", { @@ -13108,32 +14716,36 @@ "section": "def-common.JsonObject", "text": "JsonObject" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 126 + }, + "deprecated": false } ], - "description": [], - "label": "esKuery", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 123 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.esQuery", "type": "Object", "tags": [], + "label": "esQuery", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 129 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.esQuery.buildEsQuery", "type": "Function", + "tags": [], "label": "buildEsQuery", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 130 - }, "signature": [ "typeof ", { @@ -13143,18 +14755,20 @@ "section": "def-common.buildEsQuery", "text": "buildEsQuery" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 130 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esQuery.getEsQueryConfig", "type": "Function", + "tags": [], "label": "getEsQueryConfig", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 131 - }, "signature": [ "typeof ", { @@ -13164,18 +14778,20 @@ "section": "def-common.getEsQueryConfig", "text": "getEsQueryConfig" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 131 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esQuery.buildQueryFromFilters", "type": "Function", + "tags": [], "label": "buildQueryFromFilters", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 132 - }, "signature": [ "(filters: ", { @@ -13210,18 +14826,20 @@ "text": "Filter" }, "[]; }" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 132 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esQuery.luceneStringToDsl", "type": "Function", + "tags": [], "label": "luceneStringToDsl", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 133 - }, "signature": [ "typeof ", { @@ -13231,18 +14849,20 @@ "section": "def-common.luceneStringToDsl", "text": "luceneStringToDsl" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 133 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.esQuery.decorateQuery", "type": "Function", + "tags": [], "label": "decorateQuery", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 134 - }, "signature": [ "typeof ", { @@ -13252,32 +14872,36 @@ "section": "def-common.decorateQuery", "text": "decorateQuery" } - ] - } - ], - "description": [], - "label": "esQuery", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 129 - }, + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 134 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.exporters", "type": "Object", "tags": [], + "label": "exporters", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 213 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.exporters.datatableToCSV", "type": "Function", + "tags": [], "label": "datatableToCSV", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 214 - }, "signature": [ "typeof ", { @@ -13287,43 +14911,49 @@ "section": "def-common.datatableToCSV", "text": "datatableToCSV" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 214 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.exporters.CSV_MIME_TYPE", "type": "string", + "tags": [], "label": "CSV_MIME_TYPE", "description": [], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 215 - } + }, + "deprecated": false } ], - "description": [], - "label": "exporters", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 213 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.fieldFormats", "type": "Object", "tags": [], + "label": "fieldFormats", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 170 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.FieldFormat", "type": "Object", + "tags": [], "label": "FieldFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 171 - }, "signature": [ "typeof ", { @@ -13333,18 +14963,20 @@ "section": "def-common.FieldFormat", "text": "FieldFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 171 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.FieldFormatsRegistry", "type": "Object", + "tags": [], "label": "FieldFormatsRegistry", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 172 - }, "signature": [ "typeof ", { @@ -13354,32 +14986,36 @@ "section": "def-common.FieldFormatsRegistry", "text": "FieldFormatsRegistry" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 172 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.DEFAULT_CONVERTER_COLOR", "type": "Object", + "tags": [], "label": "DEFAULT_CONVERTER_COLOR", "description": [], + "signature": [ + "{ range: string; regex: string; text: string; background: string; }" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 174 }, - "signature": [ - "{ range: string; regex: string; text: string; background: string; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.HTML_CONTEXT_TYPE", "type": "CompoundType", + "tags": [], "label": "HTML_CONTEXT_TYPE", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 175 - }, "signature": [ { "pluginId": "data", @@ -13388,18 +15024,20 @@ "section": "def-common.FieldFormatsContentType", "text": "FieldFormatsContentType" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 175 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.TEXT_CONTEXT_TYPE", "type": "CompoundType", + "tags": [], "label": "TEXT_CONTEXT_TYPE", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 176 - }, "signature": [ { "pluginId": "data", @@ -13408,18 +15046,20 @@ "section": "def-common.FieldFormatsContentType", "text": "FieldFormatsContentType" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 176 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.FIELD_FORMAT_IDS", "type": "Object", + "tags": [], "label": "FIELD_FORMAT_IDS", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 177 - }, "signature": [ "typeof ", { @@ -13429,18 +15069,20 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 177 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.BoolFormat", "type": "Object", + "tags": [], "label": "BoolFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 179 - }, "signature": [ "typeof ", { @@ -13450,18 +15092,20 @@ "section": "def-common.BoolFormat", "text": "BoolFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 179 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.BytesFormat", "type": "Object", + "tags": [], "label": "BytesFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 180 - }, "signature": [ "typeof ", { @@ -13471,18 +15115,20 @@ "section": "def-common.BytesFormat", "text": "BytesFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 180 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.ColorFormat", "type": "Object", + "tags": [], "label": "ColorFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 181 - }, "signature": [ "typeof ", { @@ -13492,48 +15138,54 @@ "section": "def-common.ColorFormat", "text": "ColorFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 181 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.DateFormat", "type": "Object", + "tags": [], "label": "DateFormat", "description": [], + "signature": [ + "typeof ", + "DateFormat" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 182 }, - "signature": [ - "typeof ", - "DateFormat" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.DateNanosFormat", "type": "Object", + "tags": [], "label": "DateNanosFormat", "description": [], + "signature": [ + "typeof ", + "DateNanosFormat" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 183 }, - "signature": [ - "typeof ", - "DateNanosFormat" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.DurationFormat", "type": "Object", + "tags": [], "label": "DurationFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 184 - }, "signature": [ "typeof ", { @@ -13543,18 +15195,20 @@ "section": "def-common.DurationFormat", "text": "DurationFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 184 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.IpFormat", "type": "Object", + "tags": [], "label": "IpFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 185 - }, "signature": [ "typeof ", { @@ -13564,18 +15218,20 @@ "section": "def-common.IpFormat", "text": "IpFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 185 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.NumberFormat", "type": "Object", + "tags": [], "label": "NumberFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 186 - }, "signature": [ "typeof ", { @@ -13585,18 +15241,20 @@ "section": "def-common.NumberFormat", "text": "NumberFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 186 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.PercentFormat", "type": "Object", + "tags": [], "label": "PercentFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 187 - }, "signature": [ "typeof ", { @@ -13606,18 +15264,20 @@ "section": "def-common.PercentFormat", "text": "PercentFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 187 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.RelativeDateFormat", "type": "Object", + "tags": [], "label": "RelativeDateFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 188 - }, "signature": [ "typeof ", { @@ -13627,18 +15287,20 @@ "section": "def-common.RelativeDateFormat", "text": "RelativeDateFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 188 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.SourceFormat", "type": "Object", + "tags": [], "label": "SourceFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 189 - }, "signature": [ "typeof ", { @@ -13648,18 +15310,20 @@ "section": "def-common.SourceFormat", "text": "SourceFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 189 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.StaticLookupFormat", "type": "Object", + "tags": [], "label": "StaticLookupFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 190 - }, "signature": [ "typeof ", { @@ -13669,18 +15333,20 @@ "section": "def-common.StaticLookupFormat", "text": "StaticLookupFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 190 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.UrlFormat", "type": "Object", + "tags": [], "label": "UrlFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 191 - }, "signature": [ "typeof ", { @@ -13690,18 +15356,20 @@ "section": "def-common.UrlFormat", "text": "UrlFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 191 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.StringFormat", "type": "Object", + "tags": [], "label": "StringFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 192 - }, "signature": [ "typeof ", { @@ -13711,18 +15379,20 @@ "section": "def-common.StringFormat", "text": "StringFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 192 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.TruncateFormat", "type": "Object", + "tags": [], "label": "TruncateFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 193 - }, "signature": [ "typeof ", { @@ -13732,18 +15402,20 @@ "section": "def-common.TruncateFormat", "text": "TruncateFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 193 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.fieldFormats.HistogramFormat", "type": "Object", + "tags": [], "label": "HistogramFormat", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 194 - }, "signature": [ "typeof ", { @@ -13753,82 +15425,94 @@ "section": "def-common.HistogramFormat", "text": "HistogramFormat" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 194 + }, + "deprecated": false } ], - "description": [], - "label": "fieldFormats", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 170 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.indexPatterns", "type": "Object", "tags": [], + "label": "indexPatterns", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 238 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_KEY", "type": "string", + "tags": [], "label": "ILLEGAL_CHARACTERS_KEY", "description": [], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 239 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.indexPatterns.CONTAINS_SPACES_KEY", "type": "string", + "tags": [], "label": "CONTAINS_SPACES_KEY", "description": [], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 240 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_VISIBLE", "type": "Array", + "tags": [], "label": "ILLEGAL_CHARACTERS_VISIBLE", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 241 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS", "type": "Array", + "tags": [], "label": "ILLEGAL_CHARACTERS", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 242 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.indexPatterns.isDefault", "type": "Function", + "tags": [], "label": "isDefault", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 243 - }, "signature": [ "(indexPattern: ", { @@ -13839,18 +15523,20 @@ "text": "IIndexPattern" }, ") => boolean" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 243 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.indexPatterns.isFilterable", "type": "Function", + "tags": [], "label": "isFilterable", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 244 - }, "signature": [ "typeof ", { @@ -13860,18 +15546,20 @@ "section": "def-common.isFilterable", "text": "isFilterable" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 244 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.indexPatterns.isNestedField", "type": "Function", + "tags": [], "label": "isNestedField", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 245 - }, "signature": [ "typeof ", { @@ -13881,82 +15569,100 @@ "section": "def-common.isNestedField", "text": "isNestedField" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 245 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.indexPatterns.validate", "type": "Function", + "tags": [], "label": "validate", "description": [], + "signature": [ + "typeof ", + "validateIndexPattern" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 246 }, - "signature": [ - "typeof ", - "validateIndexPattern" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.indexPatterns.flattenHitWrapper", "type": "Function", + "tags": [], "label": "flattenHitWrapper", "description": [], + "signature": [ + "typeof ", + "flattenHitWrapper" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 247 }, - "signature": [ - "typeof ", - "flattenHitWrapper" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.indexPatterns.formatHitProvider", "type": "Function", + "tags": [], "label": "formatHitProvider", "description": [], + "signature": [ + "typeof ", + "formatHitProvider" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 248 }, - "signature": [ - "typeof ", - "formatHitProvider" - ] + "deprecated": false } ], - "description": [], - "label": "indexPatterns", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 238 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.search", "type": "Object", "tags": [], + "label": "search", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 407 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.search.aggs", "type": "Object", "tags": [], + "label": "aggs", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 408 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.CidrMask", "type": "Object", + "tags": [], "label": "CidrMask", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 408 - }, "signature": [ "typeof ", { @@ -13966,18 +15672,20 @@ "section": "def-common.CidrMask", "text": "CidrMask" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 409 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.dateHistogramInterval", "type": "Function", + "tags": [], "label": "dateHistogramInterval", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 409 - }, "signature": [ "typeof ", { @@ -13987,18 +15695,20 @@ "section": "def-common.dateHistogramInterval", "text": "dateHistogramInterval" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 410 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.intervalOptions", "type": "Array", + "tags": [], "label": "intervalOptions", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 410 - }, "signature": [ "({ display: string; val: string; enabled(agg: ", { @@ -14009,18 +15719,20 @@ "text": "IBucketAggConfig" }, "): boolean; } | { display: string; val: string; })[]" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 411 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.InvalidEsCalendarIntervalError", "type": "Object", + "tags": [], "label": "InvalidEsCalendarIntervalError", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 411 - }, "signature": [ "typeof ", { @@ -14030,18 +15742,20 @@ "section": "def-common.InvalidEsCalendarIntervalError", "text": "InvalidEsCalendarIntervalError" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 412 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.InvalidEsIntervalFormatError", "type": "Object", + "tags": [], "label": "InvalidEsIntervalFormatError", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 412 - }, "signature": [ "typeof ", { @@ -14051,18 +15765,20 @@ "section": "def-common.InvalidEsIntervalFormatError", "text": "InvalidEsIntervalFormatError" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 413 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.Ipv4Address", "type": "Object", + "tags": [], "label": "Ipv4Address", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 413 - }, "signature": [ "typeof ", { @@ -14072,18 +15788,20 @@ "section": "def-common.Ipv4Address", "text": "Ipv4Address" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 414 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.isDateHistogramBucketAggConfig", "type": "Function", + "tags": [], "label": "isDateHistogramBucketAggConfig", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 414 - }, "signature": [ "typeof ", { @@ -14093,18 +15811,20 @@ "section": "def-common.isDateHistogramBucketAggConfig", "text": "isDateHistogramBucketAggConfig" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 415 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.isNumberType", "type": "Function", + "tags": [], "label": "isNumberType", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 415 - }, "signature": [ "(agg: ", { @@ -14115,18 +15835,20 @@ "text": "AggConfig" }, ") => boolean" - ] - }, + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 416 + }, + "deprecated": false + }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.isStringType", "type": "Function", + "tags": [], "label": "isStringType", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 416 - }, "signature": [ "(agg: ", { @@ -14137,18 +15859,20 @@ "text": "AggConfig" }, ") => boolean" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 417 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.isType", "type": "Function", + "tags": [], "label": "isType", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 417 - }, "signature": [ "(...types: string[]) => (agg: ", { @@ -14159,18 +15883,20 @@ "text": "AggConfig" }, ") => boolean" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 418 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.isValidEsInterval", "type": "Function", + "tags": [], "label": "isValidEsInterval", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 418 - }, "signature": [ "typeof ", { @@ -14180,18 +15906,20 @@ "section": "def-common.isValidEsInterval", "text": "isValidEsInterval" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 419 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.isValidInterval", "type": "Function", + "tags": [], "label": "isValidInterval", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 419 - }, "signature": [ "typeof ", { @@ -14201,29 +15929,33 @@ "section": "def-common.isValidInterval", "text": "isValidInterval" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 420 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.parentPipelineType", "type": "string", + "tags": [], "label": "parentPipelineType", "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 420 - } + "lineNumber": 421 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.parseEsInterval", "type": "Function", + "tags": [], "label": "parseEsInterval", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 421 - }, "signature": [ "typeof ", { @@ -14233,18 +15965,20 @@ "section": "def-common.parseEsInterval", "text": "parseEsInterval" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 422 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.parseInterval", "type": "Function", + "tags": [], "label": "parseInterval", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 422 - }, "signature": [ "typeof ", { @@ -14254,18 +15988,20 @@ "section": "def-common.parseInterval", "text": "parseInterval" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 423 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.propFilter", "type": "Function", + "tags": [], "label": "propFilter", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 423 - }, "signature": [ "typeof ", { @@ -14275,43 +16011,49 @@ "section": "def-common.propFilter", "text": "propFilter" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 424 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.siblingPipelineType", "type": "string", + "tags": [], "label": "siblingPipelineType", "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 424 - } + "lineNumber": 425 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.termsAggFilter", "type": "Array", + "tags": [], "label": "termsAggFilter", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 425 + "lineNumber": 426 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.toAbsoluteDates", "type": "Function", + "tags": [], "label": "toAbsoluteDates", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 426 - }, "signature": [ "typeof ", { @@ -14321,32 +16063,36 @@ "section": "def-common.toAbsoluteDates", "text": "toAbsoluteDates" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 427 + }, + "deprecated": false }, { - "tags": [], + "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; })[]" + ], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 427 + "lineNumber": 428 }, - "signature": [ - "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.getNumberHistogramIntervalByDatatableColumn", "type": "Function", + "tags": [], "label": "getNumberHistogramIntervalByDatatableColumn", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 428 - }, "signature": [ "(column: ", { @@ -14357,18 +16103,20 @@ "text": "DatatableColumn" }, ") => number | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 429 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn", "type": "Function", + "tags": [], "label": "getDateHistogramMetaDataByDatatableColumn", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 429 - }, "signature": [ "(column: ", { @@ -14387,47 +16135,22 @@ "text": "TimeRange" }, " | undefined; } | undefined" - ] - } - ], - "description": [], - "label": "aggs", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 407 - } - }, - { - "tags": [], - "id": "def-public.search.getRequestInspectorStats", - "type": "Function", - "label": "getRequestInspectorStats", - "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 431 - }, - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.getRequestInspectorStats", - "text": "getRequestInspectorStats" + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 430 + }, + "deprecated": false } ] }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.getResponseInspectorStats", "type": "Function", + "tags": [], "label": "getResponseInspectorStats", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 432 - }, "signature": [ "typeof ", { @@ -14437,18 +16160,20 @@ "section": "def-common.getResponseInspectorStats", "text": "getResponseInspectorStats" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 432 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.tabifyAggResponse", "type": "Function", + "tags": [], "label": "tabifyAggResponse", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 433 - }, "signature": [ "typeof ", { @@ -14458,18 +16183,20 @@ "section": "def-common.tabifyAggResponse", "text": "tabifyAggResponse" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 433 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.search.tabifyGetColumns", "type": "Function", + "tags": [], "label": "tabifyGetColumns", "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 434 - }, "signature": [ "typeof ", { @@ -14479,52 +16206,56 @@ "section": "def-common.tabifyGetColumns", "text": "tabifyGetColumns" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 434 + }, + "deprecated": false } ], - "description": [], - "label": "search", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 406 - }, "initialIsOpen": false }, { - "tags": [], + "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 COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; 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 SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }" + ], "source": { "path": "src/plugins/data/common/constants.ts", "lineNumber": 12 }, - "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 COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; 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 SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }" - ], + "deprecated": false, "initialIsOpen": false } ], "setup": { + "parentPluginId": "data", "id": "def-public.DataPublicPluginSetup", "type": "Interface", + "tags": [], "label": "DataPublicPluginSetup", "description": [ "\nData plugin public Setup contract" ], - "tags": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginSetup.autocomplete", "type": "Object", + "tags": [], "label": "autocomplete", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 46 - }, "signature": [ "{ getQuerySuggestions: ", { @@ -14535,18 +16266,20 @@ "text": "QuerySuggestionGetFn" }, "; }" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 42 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginSetup.search", "type": "Object", + "tags": [], "label": "search", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 47 - }, "signature": [ { "pluginId": "data", @@ -14555,18 +16288,20 @@ "section": "def-public.ISearchSetup", "text": "ISearchSetup" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 43 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginSetup.fieldFormats", "type": "Object", + "tags": [], "label": "fieldFormats", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 48 - }, "signature": [ "Pick<", { @@ -14577,18 +16312,20 @@ "text": "FieldFormatsRegistry" }, ", \"register\">" - ] - }, + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 44 + }, + "deprecated": false + }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginSetup.query", "type": "Object", + "tags": [], "label": "query", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 49 - }, "signature": [ "{ filterManager: ", { @@ -14612,37 +16349,41 @@ "section": "def-public.QueryStateChange", "text": "QueryStateChange" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 45 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 45 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "data", "id": "def-public.DataPublicPluginStart", "type": "Interface", + "tags": [], "label": "DataPublicPluginStart", "description": [ "\nData plugin public Start contract" ], - "tags": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 67 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStart.actions", "type": "Object", + "tags": [], "label": "actions", "description": [ "\nfilter creation utilities\n{@link DataPublicPluginStartActions}" ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 80 - }, "signature": [ { "pluginId": "data", @@ -14651,20 +16392,22 @@ "section": "def-public.DataPublicPluginStartActions", "text": "DataPublicPluginStartActions" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 72 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStart.autocomplete", "type": "Object", + "tags": [], "label": "autocomplete", "description": [ "\nautocomplete service\n{@link AutocompleteStart}" ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 85 - }, "signature": [ "{ getQuerySuggestions: ", { @@ -14677,20 +16420,22 @@ "; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ", "ValueSuggestionsGetFn", "; }" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 77 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStart.indexPatterns", "type": "Object", + "tags": [], "label": "indexPatterns", "description": [ "\nindex patterns service\n{@link IndexPatternsContract}" ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 90 - }, "signature": [ "Pick<", { @@ -14701,20 +16446,22 @@ "text": "IndexPatternsService" }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 82 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStart.search", "type": "Object", + "tags": [], "label": "search", "description": [ "\nsearch service\n{@link ISearchStart}" ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 95 - }, "signature": [ { "pluginId": "data", @@ -14723,20 +16470,22 @@ "section": "def-public.ISearchStart", "text": "ISearchStart" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 87 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStart.fieldFormats", "type": "CompoundType", + "tags": [], "label": "fieldFormats", "description": [ "\nfield formats service\n{@link FieldFormatsStart}" ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 100 - }, "signature": [ { "pluginId": "data", @@ -14745,20 +16494,22 @@ "section": "def-public.FieldFormatsStart", "text": "FieldFormatsStart" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 92 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStart.query", "type": "Object", + "tags": [], "label": "query", "description": [ "\nquery service\n{@link QueryStart}" ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 105 - }, "signature": [ "{ addToQueryLog: (appName: string, { language, query }: ", { @@ -14788,20 +16539,22 @@ }, "; state$: ", "Observable" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 97 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStart.ui", "type": "Object", + "tags": [], "label": "ui", "description": [ "\nprewired UI components\n{@link DataPublicPluginStartUi}" ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 110 - }, "signature": [ { "pluginId": "data", @@ -14810,29 +16563,32 @@ "section": "def-public.DataPublicPluginStartUi", "text": "DataPublicPluginStartUi" } - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 102 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.DataPublicPluginStart.nowProvider", "type": "Object", + "tags": [], "label": "nowProvider", "description": [], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 112 - }, "signature": [ "Pick, \"get\">" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 104 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 75 - }, "lifecycle": "start", "initialIsOpen": true } @@ -14840,6 +16596,7 @@ "server": { "classes": [ { + "parentPluginId": "data", "id": "def-server.AggParamType", "type": "Class", "tags": [], @@ -14863,76 +16620,87 @@ }, "" ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggParamType.makeAgg", "type": "Function", + "tags": [], "label": "makeAgg", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", - "lineNumber": 15 - }, "signature": [ "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggParamType.allowedAggs", "type": "Array", + "tags": [], "label": "allowedAggs", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 16 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-server.AggParamType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.AggParamType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", - "lineNumber": 18 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.DataServerPlugin", "type": "Class", "tags": [], @@ -14973,21 +16741,35 @@ ", ", "DataPluginSetupDependencies" ], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.DataServerPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.DataServerPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -14998,24 +16780,23 @@ }, "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>" ], - "description": [], "source": { "path": "src/plugins/data/server/plugin.ts", "lineNumber": 71 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 71 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.DataServerPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -15040,13 +16821,19 @@ ") => { __enhance: (enhancements: ", "DataEnhancements" ], - "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 79 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.DataServerPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -15067,38 +16854,40 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/server/plugin.ts", "lineNumber": 80 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.DataServerPlugin.setup.$2", "type": "Object", + "tags": [], "label": "{ bfetch, expressions, usageCollection }", - "isRequired": true, + "description": [], "signature": [ "DataPluginSetupDependencies" ], - "description": [], "source": { "path": "src/plugins/data/server/plugin.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 79 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.DataServerPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -15141,13 +16930,19 @@ "text": "ElasticsearchClient" } ], - "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 110 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.DataServerPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -15157,44 +16952,39 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/plugins/data/server/plugin.ts", "lineNumber": 110 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 110 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.DataServerPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/server/plugin.ts", "lineNumber": 124 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IndexPattern", "type": "Class", "tags": [], @@ -15217,58 +17007,66 @@ "text": "IIndexPattern" } ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 45 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 46 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.fieldFormatMap", "type": "Object", + "tags": [], "label": "fieldFormatMap", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 47 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.typeMeta", "type": "Object", + "tags": [], "label": "typeMeta", "description": [ "\nOnly used by rollup indices, used by rollup specific endpoint to load field list" ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 51 - }, "signature": [ { "pluginId": "data", @@ -15278,18 +17076,20 @@ "text": "TypeMeta" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.fields", "type": "CompoundType", + "tags": [], "label": "fields", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 52 - }, "signature": [ { "pluginId": "data", @@ -15307,136 +17107,155 @@ "text": "FieldSpec" }, ">; }" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 52 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 53 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-server.IndexPattern.intervalName", + "type": "string", "tags": [ "deprecated" ], - "id": "def-server.IndexPattern.intervalName", - "type": "string", "label": "intervalName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 58 }, - "signature": [ - "string | undefined" - ] + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nType is used to identify rollup index patterns" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 62 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.formatHit", "type": "Function", + "tags": [], "label": "formatHit", "description": [], + "signature": [ + "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 63 }, - "signature": [ - "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.formatField", "type": "Function", + "tags": [], "label": "formatField", "description": [], + "signature": [ + "FormatFieldFn" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 67 }, - "signature": [ - "FormatFieldFn" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.flattenHit", "type": "Function", + "tags": [], "label": "flattenHit", "description": [], + "signature": [ + "(hit: Record, deep?: boolean | undefined) => Record" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 68 }, - "signature": [ - "(hit: Record, deep?: boolean | undefined) => Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.metaFields", "type": "Array", + "tags": [], "label": "metaFields", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 69 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.version", "type": "string", + "tags": [], "label": "version", "description": [ "\nSavedObject version" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 73 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.sourceFilters", "type": "Array", + "tags": [], "label": "sourceFilters", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 74 - }, "signature": [ { "pluginId": "data", @@ -15446,12 +17265,18 @@ "text": "SourceFilter" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 74 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPattern.allowNoIndex", "type": "boolean", + "tags": [], "label": "allowNoIndex", "description": [ "\nprevents errors when index pattern exists before indices" @@ -15459,79 +17284,92 @@ "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 84 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.Unnamed.$1", "type": "Object", + "tags": [], "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", - "isRequired": true, + "description": [], "signature": [ "IndexPatternDeps" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 86 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getOriginalSavedObjectBody", "type": "Function", - "children": [], - "signature": [ - "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" - ], + "tags": [], + "label": "getOriginalSavedObjectBody", "description": [ "\nGet last saved saved object fields" ], - "label": "getOriginalSavedObjectBody", + "signature": [ + "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 128 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.resetOriginalSavedObjectBody", "type": "Function", - "children": [], - "signature": [ - "() => void" - ], + "tags": [], + "label": "resetOriginalSavedObjectBody", "description": [ "\nReset last saved saved object fields. used after saving" ], - "label": "resetOriginalSavedObjectBody", + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 133 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getFieldAttrs", "type": "Function", - "children": [], + "tags": [], + "label": "getFieldAttrs", + "description": [], "signature": [ "() => { [x: string]: ", { @@ -15543,19 +17381,21 @@ }, "; }" ], - "description": [], - "label": "getFieldAttrs", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 137 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getComputedFields", "type": "Function", + "tags": [], "label": "getComputedFields", + "description": [], "signature": [ "() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 162 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.toSpec", "type": "Function", + "tags": [], "label": "toSpec", + "description": [ + "\nCreate static representation of index pattern" + ], "signature": [ "() => ", { @@ -15590,137 +17434,155 @@ "text": "IndexPatternSpec" } ], - "description": [ - "\nCreate static representation of index pattern" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getSourceFiltering", "type": "Function", + "tags": [], "label": "getSourceFiltering", - "signature": [ - "() => { excludes: any[]; }" - ], "description": [ "\nGet the source filtering configuration for that index." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => { excludes: any[]; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 230 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.addScriptedField", "type": "Function", + "tags": [], "label": "addScriptedField", - "signature": [ - "(name: string, script: string, fieldType?: string) => Promise" - ], "description": [ "\nAdd scripted field to field list\n" ], + "signature": [ + "(name: string, script: string, fieldType?: string) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.addScriptedField.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "field name" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.addScriptedField.$2", "type": "string", + "tags": [], "label": "script", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "script code" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.addScriptedField.$3", "type": "string", + "tags": [], "label": "fieldType", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.removeScriptedField", "type": "Function", + "tags": [], "label": "removeScriptedField", - "signature": [ - "(fieldName: string) => void" - ], "description": [ "\nRemove scripted field from field list" ], + "signature": [ + "(fieldName: string) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.removeScriptedField.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 270 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 270 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getNonScriptedFields", "type": "Function", + "tags": [], "label": "getNonScriptedFields", + "description": [], "signature": [ "() => ", { @@ -15732,19 +17594,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 277 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getScriptedFields", "type": "Function", + "tags": [], "label": "getScriptedFields", + "description": [], "signature": [ "() => ", { @@ -15756,51 +17620,57 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 281 - } - }, + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.isTimeBased", "type": "Function", + "tags": [], "label": "isTimeBased", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 285 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.isTimeNanosBased", "type": "Function", + "tags": [], "label": "isTimeNanosBased", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 289 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getTimeField", "type": "Function", + "tags": [], "label": "getTimeField", + "description": [], "signature": [ "() => ", { @@ -15812,19 +17682,21 @@ }, " | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 294 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getFieldByName", "type": "Function", + "tags": [], "label": "getFieldByName", + "description": [], "signature": [ "(name: string) => ", { @@ -15836,68 +17708,79 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.getFieldByName.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 299 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 299 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getAggregationRestrictions", "type": "Function", + "tags": [], "label": "getAggregationRestrictions", + "description": [], "signature": [ "() => Record> | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 304 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getAsSavedObjectBody", "type": "Function", + "tags": [], "label": "getAsSavedObjectBody", - "signature": [ - "() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }" - ], "description": [ "\nReturns index pattern as saved object body for saving" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 311 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getFormatterForField", "type": "Function", + "tags": [], "label": "getFormatterForField", + "description": [ + "\nProvide a field, get its formatter" + ], "signature": [ "(field: ", { @@ -15932,15 +17815,19 @@ "text": "FieldFormat" } ], - "description": [ - "\nProvide a field, get its formatter" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 339 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.getFormatterForField.$1", "type": "CompoundType", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -15966,24 +17853,25 @@ "text": "FieldSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 340 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 339 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.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: ", { @@ -15995,31 +17883,40 @@ }, ") => void" ], - "description": [ - "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.addRuntimeField.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Field name" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 360 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.addRuntimeField.$2", "type": "Object", + "tags": [], "label": "runtimeField", - "isRequired": true, + "description": [ + "Runtime field definition" + ], "signature": [ { "pluginId": "data", @@ -16029,61 +17926,65 @@ "text": "RuntimeField" } ], - "description": [ - "Runtime field definition" - ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 360 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.removeRuntimeField", "type": "Function", + "tags": [], "label": "removeRuntimeField", - "signature": [ - "(name: string) => void" - ], "description": [ "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate" ], + "signature": [ + "(name: string) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.removeRuntimeField.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Field name" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 384 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 384 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.getFormatterForFieldNoDefault", "type": "Function", + "tags": [], "label": "getFormatterForFieldNoDefault", + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists" + ], "signature": [ "(fieldname: string) => ", { @@ -16095,36 +17996,39 @@ }, " | undefined" ], - "description": [ - "\nGet formatter for a given field name. Return undefined if none exists" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.getFormatterForFieldNoDefault.$1", "type": "string", + "tags": [], "label": "fieldname", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 404 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 404 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldAttrs", "type": "Function", + "tags": [], "label": "setFieldAttrs", + "description": [], "signature": [ "(fieldName: string, attrName: K, value: ", { @@ -16136,41 +18040,53 @@ }, "[K]) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 411 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldAttrs.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 412 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldAttrs.$2", "type": "Uncategorized", + "tags": [], "label": "attrName", - "isRequired": true, + "description": [], "signature": [ "K" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 413 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldAttrs.$3", "type": "Uncategorized", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -16181,133 +18097,170 @@ }, "[K]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 414 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 411 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldCustomLabel", "type": "Function", + "tags": [], "label": "setFieldCustomLabel", + "description": [], "signature": [ "(fieldName: string, customLabel: string | null | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldCustomLabel.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 422 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldCustomLabel.$2", "type": "CompoundType", + "tags": [], "label": "customLabel", - "isRequired": false, + "description": [], "signature": [ "string | null | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 422 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldCount", "type": "Function", + "tags": [], "label": "setFieldCount", + "description": [], "signature": [ "(fieldName: string, count: number | null | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldCount.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 433 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldCount.$2", "type": "CompoundType", + "tags": [], "label": "count", - "isRequired": false, + "description": [], "signature": [ "number | null | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 433 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldFormat", "type": "Function", - "children": [ + "tags": [], + "label": "setFieldFormat", + "description": [], + "signature": [ + "(fieldName: string, format: ", { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldFormat.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 446 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.setFieldFormat.$2", "type": "Object", + "tags": [], "label": "format", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -16318,316 +18271,344 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 446 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(fieldName: string, format: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - ">) => void" - ], - "description": [], - "label": "setFieldFormat", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPattern.deleteFieldFormat", "type": "Function", + "tags": [], + "label": "deleteFieldFormat", + "description": [], + "signature": [ + "(fieldName: string) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPattern.deleteFieldFormat.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 450 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(fieldName: string) => void" - ], - "description": [], - "label": "deleteFieldFormat", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 450 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService", "type": "Class", "tags": [], "label": "IndexPatternsService", "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsService.ensureDefaultIndexPattern", "type": "Function", + "tags": [], "label": "ensureDefaultIndexPattern", "description": [], + "signature": [ + "EnsureDefaultIndexPattern" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "signature": [ - "EnsureDefaultIndexPattern" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.Unnamed.$1", "type": "Object", + "tags": [], "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", - "isRequired": true, + "description": [], "signature": [ "IndexPatternsServiceDeps" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 69 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 69 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getIds", "type": "Function", + "tags": [], + "label": "getIds", + "description": [ + "\nGet list of index pattern ids" + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getIds.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 108 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.getTitles", + "type": "Function", + "tags": [], + "label": "getTitles", + "description": [ + "\nGet list of index pattern titles" + ], "signature": [ "(refresh?: boolean) => Promise" ], - "description": [ - "\nGet list of index pattern ids" - ], - "label": "getIds", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 108 + "lineNumber": 122 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.IndexPatternsService.getTitles", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getTitles.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 122 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(refresh?: boolean) => Promise" - ], - "description": [ - "\nGet list of index pattern titles" - ], - "label": "getTitles", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 122 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.find", "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nFind and load index patterns by title" + ], + "signature": [ + "(search: string, size?: number) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "[]>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.find.$1", "type": "string", + "tags": [], "label": "search", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.find.$2", "type": "number", + "tags": [], "label": "size", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(search: string, size?: number) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - "[]>" - ], - "description": [ - "\nFind and load index patterns by title" - ], - "label": "find", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 138 - }, - "tags": [], "returnComment": [ "IndexPattern[]" ] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getIdsWithTitle", "type": "Function", + "tags": [], + "label": "getIdsWithTitle", + "description": [ + "\nGet list of index pattern ids with titles" + ], + "signature": [ + "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 156 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getIdsWithTitle.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 157 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" - ], - "description": [ - "\nGet list of index pattern ids with titles" - ], - "label": "getIdsWithTitle", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 156 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.clearCache", "type": "Function", + "tags": [], + "label": "clearCache", + "description": [ + "\nClear index pattern list cache" + ], + "signature": [ + "(id?: string | undefined) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.clearCache.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 175 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(id?: string | undefined) => void" - ], - "description": [ - "\nClear index pattern list cache" - ], - "label": "clearCache", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 175 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getCache", "type": "Function", - "children": [], + "tags": [], + "label": "getCache", + "description": [], "signature": [ "() => Promise<", "SavedObject", @@ -16635,19 +18616,23 @@ "IndexPatternSavedObjectAttrs", ">[] | null | undefined>" ], - "description": [], - "label": "getCache", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 184 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getDefault", "type": "Function", - "children": [], + "tags": [], + "label": "getDefault", + "description": [ + "\nGet default index pattern" + ], "signature": [ "() => Promise<", { @@ -16659,73 +18644,102 @@ }, " | null>" ], - "description": [ - "\nGet default index pattern" - ], - "label": "getDefault", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 194 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.setDefault", "type": "Function", + "tags": [], + "label": "setDefault", + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], + "signature": [ + "(id: string, force?: boolean) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.setDefault.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.setDefault.$2", "type": "boolean", + "tags": [], "label": "force", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(id: string, force?: boolean) => Promise" - ], - "description": [ - "\nOptionally set default index pattern, unless force = true" - ], - "label": "setDefault", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 208 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getFieldsForWildcard", "type": "Function", + "tags": [], + "label": "getFieldsForWildcard", + "description": [ + "\nGet field list by providing { pattern }" + ], + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getFieldsForWildcard.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -16735,15 +18749,45 @@ "text": "GetFieldsOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 219 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.getFieldsForIndexPattern", + "type": "Function", + "tags": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet field list by providing an index patttern (or spec)" + ], "signature": [ - "(options: ", + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", options?: ", { "pluginId": "data", "scope": "common", @@ -16751,30 +18795,21 @@ "section": "def-common.GetFieldsOptions", "text": "GetFieldsOptions" }, - ") => Promise" - ], - "description": [ - "\nGet field list by providing { pattern }" + " | undefined) => Promise" ], - "label": "getFieldsForWildcard", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 219 + "lineNumber": 235 }, - "tags": [], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "id": "def-server.IndexPatternsService.getFieldsForIndexPattern", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$1", "type": "CompoundType", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -16792,17 +18827,20 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 236 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -16813,13 +18851,27 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 237 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.refreshFields", + "type": "Function", + "tags": [], + "label": "refreshFields", + "description": [ + "\nRefresh field list for a given index pattern" + ], "signature": [ "(indexPattern: ", { @@ -16829,46 +18881,21 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" }, - " | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - }, - ", options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise" - ], - "description": [ - "\nGet field list by providing an index patttern (or spec)" + ") => Promise" ], - "label": "getFieldsForIndexPattern", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 235 + "lineNumber": 250 }, - "tags": [], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "id": "def-server.IndexPatternsService.refreshFields", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.refreshFields.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -16878,44 +18905,65 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 250 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.fieldArrayToMap", + "type": "Function", + "tags": [], + "label": "fieldArrayToMap", + "description": [ + "\nConverts field array to map" + ], "signature": [ - "(indexPattern: ", + "(fields: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, - ") => Promise" - ], - "description": [ - "\nRefresh field list for a given index pattern" + "[], fieldAttrs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => Record" ], - "label": "refreshFields", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 250 + "lineNumber": 327 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.IndexPatternsService.fieldArrayToMap", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.fieldArrayToMap.$1", "type": "Array", + "tags": [], "label": "fields", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -16926,17 +18974,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 327 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.fieldArrayToMap.$2", "type": "Object", + "tags": [], "label": "fieldAttrs", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -16947,62 +18998,60 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 327 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(fields: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", + "returnComment": [ + "Record" + ] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.savedObjectToSpec", + "type": "Function", + "tags": [], + "label": "savedObjectToSpec", + "description": [ + "\nConverts index pattern saved object to index pattern spec" + ], + "signature": [ + "(savedObject: ", + "SavedObject", + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" }, - " | undefined) => Record) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ">" - ], - "description": [ - "\nConverts field array to map" + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } ], - "label": "fieldArrayToMap", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 327 + "lineNumber": 343 }, - "tags": [], - "returnComment": [ - "Record" - ] - }, - { - "id": "def-server.IndexPatternsService.savedObjectToSpec", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.savedObjectToSpec.$1", "type": "Object", + "tags": [], "label": "savedObject", - "isRequired": true, + "description": [], "signature": [ "SavedObject", "<", @@ -17015,64 +19064,26 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 343 - } - } - ], - "signature": [ - "(savedObject: ", - "SavedObject", - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternAttributes", - "text": "IndexPatternAttributes" - }, - ">) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" + }, + "deprecated": false, + "isRequired": true } ], - "description": [ - "\nConverts index pattern saved object to index pattern spec" - ], - "label": "savedObjectToSpec", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 343 - }, - "tags": [], "returnComment": [ "IndexPatternSpec" ] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.get", "type": "Function", - "children": [ - { - "id": "def-server.IndexPatternsService.get.$1", - "type": "string", - "label": "id", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 465 - } - } + "tags": [], + "label": "get", + "description": [ + "\nGet an index pattern by id. Cache optimized" ], "signature": [ "(id: string) => Promise<", @@ -17085,21 +19096,41 @@ }, ">" ], - "description": [ - "\nGet an index pattern by id. Cache optimized" - ], - "label": "get", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 465 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 465 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.create", "type": "Function", + "tags": [], "label": "create", + "description": [ + "\nCreate a new index pattern instance" + ], "signature": [ "(spec: ", { @@ -17119,15 +19150,19 @@ }, ">" ], - "description": [ - "\nCreate a new index pattern instance" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 484 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.create.$1", "type": "Object", + "tags": [], "label": "spec", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -17137,40 +19172,44 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 484 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.create.$2", "type": "boolean", + "tags": [], "label": "skipFetchFields", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 484 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "IndexPattern" - ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 484 - } + ] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createAndSave", "type": "Function", + "tags": [], "label": "createAndSave", + "description": [ + "\nCreate a new index pattern and save it right away" + ], "signature": [ "(spec: ", { @@ -17190,15 +19229,19 @@ }, ">" ], - "description": [ - "\nCreate a new index pattern and save it right away" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 509 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createAndSave.$1", "type": "Object", + "tags": [], "label": "spec", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -17208,56 +19251,63 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createAndSave.$2", "type": "boolean", + "tags": [], "label": "override", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Overwrite if existing index pattern exists." ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createAndSave.$3", "type": "boolean", + "tags": [], "label": "skipFetchFields", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Whether to skip field refresh step." ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 509 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createSavedObject", "type": "Function", + "tags": [], "label": "createSavedObject", + "description": [ + "\nSave a new index pattern" + ], "signature": [ "(indexPattern: ", { @@ -17277,15 +19327,19 @@ }, ">" ], - "description": [ - "\nSave a new index pattern" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 522 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createSavedObject.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -17295,40 +19349,44 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 522 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createSavedObject.$2", "type": "boolean", + "tags": [], "label": "override", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Overwrite if existing index pattern exists" ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 522 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 522 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.updateSavedObject", "type": "Function", + "tags": [], "label": "updateSavedObject", + "description": [ + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + ], "signature": [ "(indexPattern: ", { @@ -17340,15 +19398,19 @@ }, ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], - "description": [ - "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 550 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.updateSavedObject.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -17358,335 +19420,382 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 551 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.updateSavedObject.$2", "type": "number", + "tags": [], "label": "saveAttempts", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 552 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.updateSavedObject.$3", "type": "boolean", + "tags": [], "label": "ignoreErrors", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 553 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 550 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.delete", "type": "Function", + "tags": [], "label": "delete", - "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], "description": [ "\nDeletes an index pattern from .kibana index" ], - "children": [ - { + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 636 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.delete.$1", "type": "string", + "tags": [], "label": "indexPatternId", - "isRequired": true, - "signature": [ - "string" - ], "description": [ ": Id of kibana Index Pattern to delete" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 636 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 636 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService", "type": "Class", "tags": [], "label": "IndexPatternsService", "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsService.ensureDefaultIndexPattern", "type": "Function", + "tags": [], "label": "ensureDefaultIndexPattern", "description": [], + "signature": [ + "EnsureDefaultIndexPattern" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "signature": [ - "EnsureDefaultIndexPattern" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.Unnamed.$1", "type": "Object", + "tags": [], "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", - "isRequired": true, + "description": [], "signature": [ "IndexPatternsServiceDeps" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 69 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 69 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getIds", "type": "Function", + "tags": [], + "label": "getIds", + "description": [ + "\nGet list of index pattern ids" + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getIds.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 108 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.getTitles", + "type": "Function", + "tags": [], + "label": "getTitles", + "description": [ + "\nGet list of index pattern titles" + ], "signature": [ "(refresh?: boolean) => Promise" ], - "description": [ - "\nGet list of index pattern ids" - ], - "label": "getIds", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 108 + "lineNumber": 122 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.IndexPatternsService.getTitles", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getTitles.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 122 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(refresh?: boolean) => Promise" - ], - "description": [ - "\nGet list of index pattern titles" - ], - "label": "getTitles", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 122 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.find", "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nFind and load index patterns by title" + ], + "signature": [ + "(search: string, size?: number) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "[]>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.find.$1", "type": "string", + "tags": [], "label": "search", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.find.$2", "type": "number", + "tags": [], "label": "size", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(search: string, size?: number) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - "[]>" - ], - "description": [ - "\nFind and load index patterns by title" - ], - "label": "find", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 138 - }, - "tags": [], "returnComment": [ "IndexPattern[]" ] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getIdsWithTitle", "type": "Function", + "tags": [], + "label": "getIdsWithTitle", + "description": [ + "\nGet list of index pattern ids with titles" + ], + "signature": [ + "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 156 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getIdsWithTitle.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 157 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" - ], - "description": [ - "\nGet list of index pattern ids with titles" - ], - "label": "getIdsWithTitle", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 156 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.clearCache", "type": "Function", + "tags": [], + "label": "clearCache", + "description": [ + "\nClear index pattern list cache" + ], + "signature": [ + "(id?: string | undefined) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.clearCache.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 175 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(id?: string | undefined) => void" - ], - "description": [ - "\nClear index pattern list cache" - ], - "label": "clearCache", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 175 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getCache", "type": "Function", - "children": [], + "tags": [], + "label": "getCache", + "description": [], "signature": [ "() => Promise<", "SavedObject", @@ -17694,19 +19803,23 @@ "IndexPatternSavedObjectAttrs", ">[] | null | undefined>" ], - "description": [], - "label": "getCache", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 184 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getDefault", "type": "Function", - "children": [], + "tags": [], + "label": "getDefault", + "description": [ + "\nGet default index pattern" + ], "signature": [ "() => Promise<", { @@ -17718,73 +19831,102 @@ }, " | null>" ], - "description": [ - "\nGet default index pattern" - ], - "label": "getDefault", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 194 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.setDefault", "type": "Function", + "tags": [], + "label": "setDefault", + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], + "signature": [ + "(id: string, force?: boolean) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.setDefault.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.setDefault.$2", "type": "boolean", + "tags": [], "label": "force", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(id: string, force?: boolean) => Promise" - ], - "description": [ - "\nOptionally set default index pattern, unless force = true" - ], - "label": "setDefault", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 208 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getFieldsForWildcard", "type": "Function", + "tags": [], + "label": "getFieldsForWildcard", + "description": [ + "\nGet field list by providing { pattern }" + ], + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getFieldsForWildcard.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -17794,15 +19936,45 @@ "text": "GetFieldsOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 219 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.getFieldsForIndexPattern", + "type": "Function", + "tags": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet field list by providing an index patttern (or spec)" + ], "signature": [ - "(options: ", + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", options?: ", { "pluginId": "data", "scope": "common", @@ -17810,30 +19982,21 @@ "section": "def-common.GetFieldsOptions", "text": "GetFieldsOptions" }, - ") => Promise" - ], - "description": [ - "\nGet field list by providing { pattern }" + " | undefined) => Promise" ], - "label": "getFieldsForWildcard", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 219 + "lineNumber": 235 }, - "tags": [], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "id": "def-server.IndexPatternsService.getFieldsForIndexPattern", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$1", "type": "CompoundType", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -17851,17 +20014,20 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 236 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -17872,13 +20038,27 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 237 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.refreshFields", + "type": "Function", + "tags": [], + "label": "refreshFields", + "description": [ + "\nRefresh field list for a given index pattern" + ], "signature": [ "(indexPattern: ", { @@ -17888,46 +20068,21 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" }, - " | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - }, - ", options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise" - ], - "description": [ - "\nGet field list by providing an index patttern (or spec)" + ") => Promise" ], - "label": "getFieldsForIndexPattern", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 235 + "lineNumber": 250 }, - "tags": [], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "id": "def-server.IndexPatternsService.refreshFields", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.refreshFields.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -17937,44 +20092,65 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 250 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.fieldArrayToMap", + "type": "Function", + "tags": [], + "label": "fieldArrayToMap", + "description": [ + "\nConverts field array to map" + ], "signature": [ - "(indexPattern: ", + "(fields: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, - ") => Promise" - ], - "description": [ - "\nRefresh field list for a given index pattern" + "[], fieldAttrs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => Record" ], - "label": "refreshFields", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 250 + "lineNumber": 327 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.IndexPatternsService.fieldArrayToMap", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.fieldArrayToMap.$1", "type": "Array", + "tags": [], "label": "fields", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -17985,17 +20161,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 327 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.fieldArrayToMap.$2", "type": "Object", + "tags": [], "label": "fieldAttrs", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -18006,62 +20185,60 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 327 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [ + "Record" + ] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.savedObjectToSpec", + "type": "Function", + "tags": [], + "label": "savedObjectToSpec", + "description": [ + "\nConverts index pattern saved object to index pattern spec" + ], "signature": [ - "(fields: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", + "(savedObject: ", + "SavedObject", + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" }, - " | undefined) => Record) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ">" - ], - "description": [ - "\nConverts field array to map" + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } ], - "label": "fieldArrayToMap", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 327 + "lineNumber": 343 }, - "tags": [], - "returnComment": [ - "Record" - ] - }, - { - "id": "def-server.IndexPatternsService.savedObjectToSpec", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.savedObjectToSpec.$1", "type": "Object", + "tags": [], "label": "savedObject", - "isRequired": true, + "description": [], "signature": [ "SavedObject", "<", @@ -18074,64 +20251,26 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 343 - } - } - ], - "signature": [ - "(savedObject: ", - "SavedObject", - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternAttributes", - "text": "IndexPatternAttributes" - }, - ">) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" + }, + "deprecated": false, + "isRequired": true } ], - "description": [ - "\nConverts index pattern saved object to index pattern spec" - ], - "label": "savedObjectToSpec", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 343 - }, - "tags": [], "returnComment": [ "IndexPatternSpec" ] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.get", "type": "Function", - "children": [ - { - "id": "def-server.IndexPatternsService.get.$1", - "type": "string", - "label": "id", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 465 - } - } + "tags": [], + "label": "get", + "description": [ + "\nGet an index pattern by id. Cache optimized" ], "signature": [ "(id: string) => Promise<", @@ -18144,21 +20283,41 @@ }, ">" ], - "description": [ - "\nGet an index pattern by id. Cache optimized" - ], - "label": "get", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 465 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsService.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 465 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.create", "type": "Function", + "tags": [], "label": "create", + "description": [ + "\nCreate a new index pattern instance" + ], "signature": [ "(spec: ", { @@ -18178,15 +20337,19 @@ }, ">" ], - "description": [ - "\nCreate a new index pattern instance" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 484 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.create.$1", "type": "Object", + "tags": [], "label": "spec", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -18196,40 +20359,44 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 484 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.create.$2", "type": "boolean", + "tags": [], "label": "skipFetchFields", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 484 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "IndexPattern" - ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 484 - } + ] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createAndSave", "type": "Function", + "tags": [], "label": "createAndSave", + "description": [ + "\nCreate a new index pattern and save it right away" + ], "signature": [ "(spec: ", { @@ -18249,15 +20416,19 @@ }, ">" ], - "description": [ - "\nCreate a new index pattern and save it right away" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 509 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createAndSave.$1", "type": "Object", + "tags": [], "label": "spec", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -18267,56 +20438,63 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createAndSave.$2", "type": "boolean", + "tags": [], "label": "override", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Overwrite if existing index pattern exists." ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createAndSave.$3", "type": "boolean", + "tags": [], "label": "skipFetchFields", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Whether to skip field refresh step." ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 509 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createSavedObject", "type": "Function", + "tags": [], "label": "createSavedObject", + "description": [ + "\nSave a new index pattern" + ], "signature": [ "(indexPattern: ", { @@ -18336,15 +20514,19 @@ }, ">" ], - "description": [ - "\nSave a new index pattern" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 522 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createSavedObject.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -18354,40 +20536,44 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 522 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.createSavedObject.$2", "type": "boolean", + "tags": [], "label": "override", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Overwrite if existing index pattern exists" ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 522 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 522 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.updateSavedObject", "type": "Function", + "tags": [], "label": "updateSavedObject", + "description": [ + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + ], "signature": [ "(indexPattern: ", { @@ -18399,15 +20585,19 @@ }, ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], - "description": [ - "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 550 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.updateSavedObject.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -18417,91 +20607,95 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 551 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.updateSavedObject.$2", "type": "number", + "tags": [], "label": "saveAttempts", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 552 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.updateSavedObject.$3", "type": "boolean", + "tags": [], "label": "ignoreErrors", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 553 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 550 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.delete", "type": "Function", + "tags": [], "label": "delete", - "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], "description": [ "\nDeletes an index pattern from .kibana index" ], + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 636 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.delete.$1", "type": "string", + "tags": [], "label": "indexPatternId", - "isRequired": true, - "signature": [ - "string" - ], "description": [ ": Id of kibana Index Pattern to delete" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 636 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 636 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.OptionedParamType", "type": "Class", "tags": [], @@ -18533,17 +20727,19 @@ }, ">" ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.OptionedParamType.options", "type": "Array", + "tags": [], "label": "options", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 20 - }, "signature": [ { "pluginId": "data", @@ -18553,66 +20749,64 @@ "text": "OptionedValueProp" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 20 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-server.OptionedParamType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], - "children": [ - { + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", "id": "def-server.OptionedParamType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 22 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 19 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "data", "id": "def-server.castEsToKbnFieldTypeName", "type": "Function", - "children": [ - { - "id": "def-server.castEsToKbnFieldTypeName.$1", - "type": "string", - "label": "esType", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", - "lineNumber": 39 - } - } + "tags": [ + "return" + ], + "label": "castEsToKbnFieldTypeName", + "description": [ + "\n Get the KbnFieldType name for an esType string\n" ], "signature": [ "(esType: string) => ", @@ -18624,24 +20818,40 @@ "text": "KBN_FIELD_TYPES" } ], - "description": [ - "\n Get the KbnFieldType name for an esType string\n" - ], - "label": "castEsToKbnFieldTypeName", "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", "lineNumber": 39 }, - "tags": [ - "return" + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.castEsToKbnFieldTypeName.$1", + "type": "string", + "tags": [], + "label": "esType", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 39 + }, + "deprecated": false, + "isRequired": true + } ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.getTime", "type": "Function", + "tags": [], "label": "getTime", + "description": [], "signature": [ "(indexPattern: ", { @@ -18669,13 +20879,19 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.getTime.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -18686,17 +20902,20 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-server.getTime.$2", "type": "Object", + "tags": [], "label": "timeRange", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -18706,621 +20925,711 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.getTime.$3.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.getTime.$3.options.forceNow", "type": "Object", + "tags": [], "label": "forceNow", "description": [], + "signature": [ + "Date | undefined" + ], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 40 }, - "signature": [ - "Date | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.getTime.$3.options.fieldName", "type": "string", + "tags": [], "label": "fieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 40 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "lineNumber": 40 - } + ] } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "lineNumber": 37 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.parseInterval", "type": "Function", + "tags": [], "label": "parseInterval", + "description": [], "signature": [ "(interval: string) => moment.Duration | null" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.parseInterval.$1", "type": "string", + "tags": [], "label": "interval", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "lineNumber": 29 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping", "type": "Interface", + "tags": [], "label": "AggFunctionsMapping", "description": [ "\nA global list of the expression function definitions for each agg type function." ], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 195 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggFilter", "type": "Object", + "tags": [], "label": "aggFilter", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 196 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggFilters", "type": "Object", + "tags": [], "label": "aggFilters", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 197 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggSignificantTerms", "type": "Object", + "tags": [], "label": "aggSignificantTerms", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 198 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggIpRange", "type": "Object", + "tags": [], "label": "aggIpRange", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 199 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggDateRange", "type": "Object", + "tags": [], "label": "aggDateRange", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 200 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggRange", "type": "Object", + "tags": [], "label": "aggRange", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 201 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggGeoTile", "type": "Object", + "tags": [], "label": "aggGeoTile", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 202 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggGeoHash", "type": "Object", + "tags": [], "label": "aggGeoHash", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 203 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggHistogram", "type": "Object", + "tags": [], "label": "aggHistogram", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 204 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggDateHistogram", "type": "Object", + "tags": [], "label": "aggDateHistogram", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 205 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggTerms", "type": "Object", + "tags": [], "label": "aggTerms", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 206 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggAvg", "type": "Object", + "tags": [], "label": "aggAvg", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 207 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggBucketAvg", "type": "Object", + "tags": [], "label": "aggBucketAvg", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 208 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggBucketMax", "type": "Object", + "tags": [], "label": "aggBucketMax", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 209 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggBucketMin", "type": "Object", + "tags": [], "label": "aggBucketMin", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 210 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggBucketSum", "type": "Object", + "tags": [], "label": "aggBucketSum", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 211 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggFilteredMetric", "type": "Object", + "tags": [], "label": "aggFilteredMetric", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 212 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggCardinality", "type": "Object", + "tags": [], "label": "aggCardinality", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 213 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggCount", "type": "Object", + "tags": [], "label": "aggCount", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 214 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggCumulativeSum", "type": "Object", + "tags": [], "label": "aggCumulativeSum", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 215 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggDerivative", "type": "Object", + "tags": [], "label": "aggDerivative", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 216 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggGeoBounds", "type": "Object", + "tags": [], "label": "aggGeoBounds", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 217 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggGeoCentroid", "type": "Object", + "tags": [], "label": "aggGeoCentroid", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 218 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggMax", "type": "Object", + "tags": [], "label": "aggMax", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 219 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggMedian", "type": "Object", + "tags": [], "label": "aggMedian", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 220 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggSinglePercentile", "type": "Object", + "tags": [], "label": "aggSinglePercentile", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 221 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggMin", "type": "Object", + "tags": [], "label": "aggMin", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 222 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggMovingAvg", "type": "Object", + "tags": [], "label": "aggMovingAvg", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 223 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggPercentileRanks", "type": "Object", + "tags": [], "label": "aggPercentileRanks", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 224 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggPercentiles", "type": "Object", + "tags": [], "label": "aggPercentiles", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 225 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggSerialDiff", "type": "Object", + "tags": [], "label": "aggSerialDiff", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 226 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggStdDeviation", "type": "Object", + "tags": [], "label": "aggStdDeviation", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 227 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggSum", "type": "Object", + "tags": [], "label": "aggSum", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 228 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggFunctionsMapping.aggTopHit", "type": "Object", + "tags": [], "label": "aggTopHit", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 229 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 195 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.AggParamOption", "type": "Interface", + "tags": [], "label": "AggParamOption", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggParamOption.val", "type": "string", + "tags": [], "label": "val", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggParamOption.display", "type": "string", + "tags": [], "label": "display", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-server.AggParamOption.enabled", "type": "Function", + "tags": [], "label": "enabled", + "description": [], "signature": [ "((agg: ", { @@ -19332,13 +21641,19 @@ }, ") => boolean) | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.AggParamOption.enabled.$1", "type": "Object", + "tags": [], "label": "agg", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -19348,148 +21663,161 @@ "text": "AggConfig" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_params.ts", - "lineNumber": 33 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_params.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.EsQueryConfig", "type": "Interface", + "tags": [], "label": "EsQueryConfig", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.EsQueryConfig.allowLeadingWildcards", "type": "boolean", + "tags": [], "label": "allowLeadingWildcards", "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.EsQueryConfig.queryStringOptions", "type": "Object", + "tags": [], "label": "queryStringOptions", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 19 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.EsQueryConfig.ignoreFilterIfFieldNotInIndex", "type": "boolean", + "tags": [], "label": "ignoreFilterIfFieldNotInIndex", "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.EsQueryConfig.dateFormatTZ", "type": "string", + "tags": [], "label": "dateFormatTZ", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.FieldFormatConfig", "type": "Interface", + "tags": [], "label": "FieldFormatConfig", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldFormatConfig.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 63 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldFormatConfig.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 64 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldFormatConfig.es", "type": "CompoundType", + "tags": [], "label": "es", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 65 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 62 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IEsSearchRequest", "type": "Interface", + "tags": [], "label": "IEsSearchRequest", + "description": [], "signature": [ { "pluginId": "data", @@ -19516,265 +21844,301 @@ }, ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.IEsSearchRequest.indexType", "type": "string", + "tags": [], "label": "indexType", "description": [], + "signature": [ + "string | undefined" + ], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IFieldSubType", "type": "Interface", + "tags": [], "label": "IFieldSubType", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 153 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldSubType.multi", "type": "Object", + "tags": [], "label": "multi", "description": [], + "signature": [ + "{ parent: string; } | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 154 }, - "signature": [ - "{ parent: string; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldSubType.nested", "type": "Object", + "tags": [], "label": "nested", "description": [], + "signature": [ + "{ path: string; } | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 155 }, - "signature": [ - "{ path: string; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 153 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IFieldType", "type": "Interface", + "tags": [], "label": "IFieldType", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.script", "type": "string", + "tags": [], "label": "script", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 14 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.lang", "type": "string", + "tags": [], "label": "lang", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 15 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.count", "type": "number", + "tags": [], "label": "count", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 16 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.esTypes", "type": "Array", + "tags": [], "label": "esTypes", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 19 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.aggregatable", "type": "CompoundType", + "tags": [], "label": "aggregatable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 20 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.filterable", "type": "CompoundType", + "tags": [], "label": "filterable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 21 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.searchable", "type": "CompoundType", + "tags": [], "label": "searchable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 22 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.sortable", "type": "CompoundType", + "tags": [], "label": "sortable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 23 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.visualizable", "type": "CompoundType", + "tags": [], "label": "visualizable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 24 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.readFromDocValues", "type": "CompoundType", + "tags": [], "label": "readFromDocValues", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 25 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.scripted", "type": "CompoundType", + "tags": [], "label": "scripted", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 26 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.subType", "type": "Object", + "tags": [], "label": "subType", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "lineNumber": 27 - }, "signature": [ { "pluginId": "data", @@ -19784,60 +22148,68 @@ "text": "IFieldSubType" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 27 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 28 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.customLabel", "type": "string", + "tags": [], "label": "customLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 29 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.format", "type": "Any", + "tags": [], "label": "format", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 30 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IFieldType.toSpec", "type": "Function", + "tags": [], "label": "toSpec", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "lineNumber": 31 - }, "signature": [ "((options?: { getFormatterForField?: ((field: ", { @@ -19879,290 +22251,330 @@ "section": "def-common.FieldSpec", "text": "FieldSpec" } - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 31 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes", "type": "Interface", + "tags": [], "label": "IndexPatternAttributes", "description": [ "\nInterface for an index pattern saved object" ], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 54 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.fields", "type": "string", + "tags": [], "label": "fields", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 56 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.typeMeta", "type": "string", + "tags": [], "label": "typeMeta", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 58 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.intervalName", "type": "string", + "tags": [], "label": "intervalName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 59 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.sourceFilters", "type": "string", + "tags": [], "label": "sourceFilters", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 60 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.fieldFormatMap", "type": "string", + "tags": [], "label": "fieldFormatMap", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 61 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.fieldAttrs", "type": "string", + "tags": [], "label": "fieldAttrs", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 62 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.runtimeFieldMap", "type": "string", + "tags": [], "label": "runtimeFieldMap", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 63 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternAttributes.allowNoIndex", "type": "CompoundType", + "tags": [], "label": "allowNoIndex", "description": [ "\nprevents errors when index pattern exists before indices" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 67 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.ISearchOptions", "type": "Interface", + "tags": [], "label": "ISearchOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 90 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchOptions.abortSignal", "type": "Object", + "tags": [], "label": "abortSignal", "description": [ "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." ], + "signature": [ + "AbortSignal | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 87 + "lineNumber": 94 }, - "signature": [ - "AbortSignal | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 92 + "lineNumber": 99 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 98 + "lineNumber": 105 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 103 + "lineNumber": 110 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 108 + "lineNumber": 115 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 114 + "lineNumber": 121 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchOptions.indexPattern", "type": "Object", + "tags": [], "label": "indexPattern", "description": [ "\nIndex pattern reference is used for better error messages" ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 120 - }, "signature": [ { "pluginId": "data", @@ -20172,110 +22584,151 @@ "text": "IndexPattern" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 126 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.inspector", + "type": "Object", + "tags": [], + "label": "inspector", + "description": [ + "\nInspector integration options" + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IInspectorInfo", + "text": "IInspectorInfo" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 131 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 83 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.KueryNode", "type": "Interface", + "tags": [], "label": "KueryNode", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.KueryNode.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 12 }, - "signature": [ - "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-server.KueryNode.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 13 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/kuery/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.OptionedValueProp", "type": "Interface", + "tags": [], "label": "OptionedValueProp", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.OptionedValueProp.value", "type": "string", + "tags": [], "label": "value", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.OptionedValueProp.text", "type": "string", + "tags": [], "label": "text", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.OptionedValueProp.disabled", "type": "CompoundType", + "tags": [], "label": "disabled", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 15 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.OptionedValueProp.isCompatible", "type": "Function", + "tags": [], "label": "isCompatible", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 16 - }, "signature": [ "(agg: ", { @@ -20286,177 +22739,193 @@ "text": "AggConfig" }, ") => boolean" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.RefreshInterval", "type": "Interface", + "tags": [], "label": "RefreshInterval", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.RefreshInterval.pause", "type": "boolean", + "tags": [], "label": "pause", "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.RefreshInterval.value", "type": "number", + "tags": [], "label": "value", "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 13 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/query/timefilter/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "data", "id": "def-server.BUCKET_TYPES", "type": "Enum", - "label": "BUCKET_TYPES", "tags": [], + "label": "BUCKET_TYPES", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", "lineNumber": 9 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.ES_FIELD_TYPES", "type": "Enum", + "tags": [], "label": "ES_FIELD_TYPES", - "tags": [ - "public" - ], "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", "lineNumber": 18 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.KBN_FIELD_TYPES", "type": "Enum", + "tags": [], "label": "KBN_FIELD_TYPES", - "tags": [ - "public" - ], "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", "lineNumber": 64 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.METRIC_TYPES", "type": "Enum", - "label": "METRIC_TYPES", "tags": [], + "label": "METRIC_TYPES", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", "lineNumber": 9 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "data", "id": "def-server.AggConfigOptions", "type": "Type", - "label": "AggConfigOptions", "tags": [], + "label": "AggConfigOptions", "description": [], + "signature": [ + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 43 }, - "signature": [ - "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.AggGroupName", "type": "Type", - "label": "AggGroupName", "tags": [], + "label": "AggGroupName", "description": [], + "signature": [ + "\"buckets\" | \"metrics\" | \"none\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 18 }, - "signature": [ - "\"buckets\" | \"metrics\" | \"none\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.AggParam", "type": "Type", - "label": "AggParam", "tags": [], + "label": "AggParam", "description": [], + "signature": [ + "BaseParamType" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 28 }, - "signature": [ - "BaseParamType" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.ES_SEARCH_STRATEGY", "type": "string", + "tags": [], "label": "ES_SEARCH_STRATEGY", "description": [], - "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", - "lineNumber": 12 - }, "signature": [ "\"es\"" ], + "source": { + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "lineNumber": 12 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.EsaggsExpressionFunctionDefinition", "type": "Type", - "label": "EsaggsExpressionFunctionDefinition", "tags": [], + "label": "EsaggsExpressionFunctionDefinition", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", - "lineNumber": 35 - }, "signature": [ "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", { @@ -20478,33 +22947,37 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", + "lineNumber": 35 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.ExecutionContextSearch", "type": "Type", - "label": "ExecutionContextSearch", "tags": [], + "label": "ExecutionContextSearch", "description": [], + "signature": [ + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 15 }, - "signature": [ - "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.ExpressionFunctionKibana", "type": "Type", - "label": "ExpressionFunctionKibana", "tags": [], + "label": "ExpressionFunctionKibana", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kibana.ts", - "lineNumber": 17 - }, "signature": [ "ExpressionFunctionDefinition<\"kibana\", ", { @@ -20524,18 +22997,20 @@ }, "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" ], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 17 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.ExpressionFunctionKibanaContext", "type": "Type", - "label": "ExpressionFunctionKibanaContext", "tags": [], + "label": "ExpressionFunctionKibanaContext", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_context.ts", - "lineNumber": 34 - }, "signature": [ "ExpressionFunctionDefinition<\"kibana_context\", ", { @@ -20555,111 +23030,125 @@ }, "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" ], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 34 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.ExpressionValueSearchContext", "type": "Type", - "label": "ExpressionValueSearchContext", "tags": [], + "label": "ExpressionValueSearchContext", "description": [], + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 21 }, - "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.FieldFormatsGetConfigFn", "type": "Type", - "label": "FieldFormatsGetConfigFn", "tags": [], + "label": "FieldFormatsGetConfigFn", "description": [], + "signature": [ + "(key: string, defaultOverride: T | undefined) => T" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 68 }, - "signature": [ - "(key: string, defaultOverride: T | undefined) => T" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.Filter", "type": "Type", - "label": "Filter", "tags": [], + "label": "Filter", "description": [], + "signature": [ + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 41 }, - "signature": [ - "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IAggConfig", "type": "Type", - "label": "IAggConfig", "tags": [ "name", "description" ], + "label": "IAggConfig", "description": [], + "signature": [ + "AggConfig" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 53 }, - "signature": [ - "AggConfig" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IAggType", "type": "Type", - "label": "IAggType", "tags": [], + "label": "IAggType", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 59 - }, "signature": [ "AggType>" ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 62 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IEsSearchResponse", "type": "Type", - "label": "IEsSearchResponse", "tags": [], + "label": "IEsSearchResponse", "description": [], - "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", - "lineNumber": 22 - }, "signature": [ "IKibanaSearchResponse>" ], + "source": { + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "lineNumber": 22 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IFieldFormatsRegistry", "type": "Type", - "label": "IFieldFormatsRegistry", "tags": [], + "label": "IFieldFormatsRegistry", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/index.ts", - "lineNumber": 11 - }, "signature": [ "{ init: (getConfig: ", { @@ -20684,48 +23173,54 @@ "text": "KBN_FIELD_TYPES" } ], + "source": { + "path": "src/plugins/data/common/field_formats/index.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IFieldParamType", "type": "Type", - "label": "IFieldParamType", "tags": [], + "label": "IFieldParamType", "description": [], + "signature": [ + "FieldParamType" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 24 }, - "signature": [ - "FieldParamType" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IMetricAggType", "type": "Type", - "label": "IMetricAggType", "tags": [], + "label": "IMetricAggType", "description": [], + "signature": [ + "MetricAggType" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 35 }, - "signature": [ - "MetricAggType" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IndexPatternLoadExpressionFunctionDefinition", "type": "Type", - "label": "IndexPatternLoadExpressionFunctionDefinition", "tags": [], + "label": "IndexPatternLoadExpressionFunctionDefinition", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", - "lineNumber": 35 - }, "signature": [ "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", { @@ -20747,147 +23242,175 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 35 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.KibanaContext", "type": "Type", - "label": "KibanaContext", "tags": [], + "label": "KibanaContext", "description": [], + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 32 }, - "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.ParsedInterval", "type": "Type", - "label": "ParsedInterval", "tags": [], + "label": "ParsedInterval", "description": [], + "signature": [ + "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", "lineNumber": 18 }, - "signature": [ - "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.Query", "type": "Type", - "label": "Query", "tags": [], + "label": "Query", "description": [], + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], "source": { "path": "src/plugins/data/common/query/types.ts", "lineNumber": 12 }, - "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.TimeRange", "type": "Type", - "label": "TimeRange", "tags": [], + "label": "TimeRange", "description": [], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 17 }, - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "data", "id": "def-server.AggGroupLabels", "type": "Object", "tags": [], + "label": "AggGroupLabels", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggGroupLabels.AggGroupNames.Buckets", "type": "string", + "tags": [], "label": "[AggGroupNames.Buckets]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggGroupLabels.AggGroupNames.Metrics", "type": "string", + "tags": [], "label": "[AggGroupNames.Metrics]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggGroupLabels.AggGroupNames.None", "type": "string", + "tags": [], "label": "[AggGroupNames.None]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 27 - } + }, + "deprecated": false } ], - "description": [], - "label": "AggGroupLabels", - "source": { - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.AggGroupNames", "type": "Object", + "tags": [], "label": "AggGroupNames", "description": [], + "signature": [ + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 12 }, - "signature": [ - "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.esFilters", "type": "Object", "tags": [], + "label": "esFilters", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.esFilters.buildQueryFilter", "type": "Function", + "tags": [], "label": "buildQueryFilter", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 30 - }, "signature": [ "(query: any, index: string, alias: string) => ", { @@ -20897,18 +23420,20 @@ "section": "def-common.QueryStringFilter", "text": "QueryStringFilter" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 30 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esFilters.buildCustomFilter", "type": "Function", + "tags": [], "label": "buildCustomFilter", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 31 - }, "signature": [ "typeof ", { @@ -20918,18 +23443,20 @@ "section": "def-common.buildCustomFilter", "text": "buildCustomFilter" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 31 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esFilters.buildEmptyFilter", "type": "Function", + "tags": [], "label": "buildEmptyFilter", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 32 - }, "signature": [ "(isPinned: boolean, index?: string | undefined) => ", { @@ -20939,18 +23466,20 @@ "section": "def-common.Filter", "text": "Filter" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 32 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esFilters.buildExistsFilter", "type": "Function", + "tags": [], "label": "buildExistsFilter", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 33 - }, "signature": [ "(field: ", { @@ -20976,18 +23505,20 @@ "section": "def-common.ExistsFilter", "text": "ExistsFilter" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esFilters.buildFilter", "type": "Function", + "tags": [], "label": "buildFilter", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 34 - }, "signature": [ "typeof ", { @@ -20997,18 +23528,20 @@ "section": "def-common.buildFilter", "text": "buildFilter" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 34 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esFilters.buildPhraseFilter", "type": "Function", + "tags": [], "label": "buildPhraseFilter", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 35 - }, "signature": [ "(field: ", { @@ -21034,18 +23567,20 @@ "section": "def-common.PhraseFilter", "text": "PhraseFilter" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 35 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esFilters.buildPhrasesFilter", "type": "Function", + "tags": [], "label": "buildPhrasesFilter", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 36 - }, "signature": [ "(field: ", { @@ -21071,18 +23606,20 @@ "section": "def-common.PhrasesFilter", "text": "PhrasesFilter" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 36 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esFilters.buildRangeFilter", "type": "Function", + "tags": [], "label": "buildRangeFilter", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 37 - }, "signature": [ "(field: ", { @@ -21116,18 +23653,20 @@ "section": "def-common.RangeFilter", "text": "RangeFilter" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esFilters.isFilterDisabled", "type": "Function", + "tags": [], "label": "isFilterDisabled", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 38 - }, "signature": [ "(filter: ", { @@ -21138,46 +23677,52 @@ "text": "Filter" }, ") => boolean" - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 38 + }, + "deprecated": false } ], - "description": [], - "label": "esFilters", - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.esKuery", "type": "Object", "tags": [], + "label": "esKuery", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.esKuery.nodeTypes", "type": "Object", + "tags": [], "label": "nodeTypes", "description": [], + "signature": [ + "NodeTypes" + ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 65 }, - "signature": [ - "NodeTypes" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esKuery.fromKueryExpression", "type": "Function", + "tags": [], "label": "fromKueryExpression", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 66 - }, "signature": [ "(expression: any, parseOptions?: Partial<", { @@ -21195,18 +23740,20 @@ "section": "def-common.KueryNode", "text": "KueryNode" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 66 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esKuery.toElasticsearchQuery", "type": "Function", + "tags": [], "label": "toElasticsearchQuery", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 67 - }, "signature": [ "(node: ", { @@ -21232,32 +23779,36 @@ "section": "def-common.JsonObject", "text": "JsonObject" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 67 + }, + "deprecated": false } ], - "description": [], - "label": "esKuery", - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 64 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.esQuery", "type": "Object", "tags": [], + "label": "esQuery", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.esQuery.buildQueryFromFilters", "type": "Function", + "tags": [], "label": "buildQueryFromFilters", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 71 - }, "signature": [ "(filters: ", { @@ -21292,18 +23843,20 @@ "text": "Filter" }, "[]; }" - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 71 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esQuery.getEsQueryConfig", "type": "Function", + "tags": [], "label": "getEsQueryConfig", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 72 - }, "signature": [ "typeof ", { @@ -21313,18 +23866,20 @@ "section": "def-common.getEsQueryConfig", "text": "getEsQueryConfig" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 72 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.esQuery.buildEsQuery", "type": "Function", + "tags": [], "label": "buildEsQuery", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 73 - }, "signature": [ "typeof ", { @@ -21334,32 +23889,36 @@ "section": "def-common.buildEsQuery", "text": "buildEsQuery" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 73 + }, + "deprecated": false } ], - "description": [], - "label": "esQuery", - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 70 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.exporters", "type": "Object", "tags": [], + "label": "exporters", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.exporters.datatableToCSV", "type": "Function", + "tags": [], "label": "datatableToCSV", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 47 - }, "signature": [ "typeof ", { @@ -21369,43 +23928,49 @@ "section": "def-common.datatableToCSV", "text": "datatableToCSV" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 47 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.exporters.CSV_MIME_TYPE", "type": "string", + "tags": [], "label": "CSV_MIME_TYPE", "description": [], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 48 - } + }, + "deprecated": false } ], - "description": [], - "label": "exporters", - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 46 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.fieldFormats", "type": "Object", "tags": [], + "label": "fieldFormats", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 101 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.FieldFormatsRegistry", "type": "Object", + "tags": [], "label": "FieldFormatsRegistry", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 102 - }, "signature": [ "typeof ", { @@ -21415,18 +23980,20 @@ "section": "def-common.FieldFormatsRegistry", "text": "FieldFormatsRegistry" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 102 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.FieldFormat", "type": "Object", + "tags": [], "label": "FieldFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 103 - }, "signature": [ "typeof ", { @@ -21436,18 +24003,20 @@ "section": "def-common.FieldFormat", "text": "FieldFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 103 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.BoolFormat", "type": "Object", + "tags": [], "label": "BoolFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 104 - }, "signature": [ "typeof ", { @@ -21457,18 +24026,20 @@ "section": "def-common.BoolFormat", "text": "BoolFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 104 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.BytesFormat", "type": "Object", + "tags": [], "label": "BytesFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 105 - }, "signature": [ "typeof ", { @@ -21478,18 +24049,20 @@ "section": "def-common.BytesFormat", "text": "BytesFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 105 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.ColorFormat", "type": "Object", + "tags": [], "label": "ColorFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 106 - }, "signature": [ "typeof ", { @@ -21499,18 +24072,20 @@ "section": "def-common.ColorFormat", "text": "ColorFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 106 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.DurationFormat", "type": "Object", + "tags": [], "label": "DurationFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 107 - }, "signature": [ "typeof ", { @@ -21520,18 +24095,20 @@ "section": "def-common.DurationFormat", "text": "DurationFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 107 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.IpFormat", "type": "Object", + "tags": [], "label": "IpFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 108 - }, "signature": [ "typeof ", { @@ -21541,18 +24118,20 @@ "section": "def-common.IpFormat", "text": "IpFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 108 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.NumberFormat", "type": "Object", + "tags": [], "label": "NumberFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 109 - }, "signature": [ "typeof ", { @@ -21562,18 +24141,20 @@ "section": "def-common.NumberFormat", "text": "NumberFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 109 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.PercentFormat", "type": "Object", + "tags": [], "label": "PercentFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 110 - }, "signature": [ "typeof ", { @@ -21583,18 +24164,20 @@ "section": "def-common.PercentFormat", "text": "PercentFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 110 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.RelativeDateFormat", "type": "Object", + "tags": [], "label": "RelativeDateFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 111 - }, "signature": [ "typeof ", { @@ -21604,18 +24187,20 @@ "section": "def-common.RelativeDateFormat", "text": "RelativeDateFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 111 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.SourceFormat", "type": "Object", + "tags": [], "label": "SourceFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 112 - }, "signature": [ "typeof ", { @@ -21625,18 +24210,20 @@ "section": "def-common.SourceFormat", "text": "SourceFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 112 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.StaticLookupFormat", "type": "Object", + "tags": [], "label": "StaticLookupFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 113 - }, "signature": [ "typeof ", { @@ -21646,18 +24233,20 @@ "section": "def-common.StaticLookupFormat", "text": "StaticLookupFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.UrlFormat", "type": "Object", + "tags": [], "label": "UrlFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 114 - }, "signature": [ "typeof ", { @@ -21667,18 +24256,20 @@ "section": "def-common.UrlFormat", "text": "UrlFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 114 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.StringFormat", "type": "Object", + "tags": [], "label": "StringFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 115 - }, "signature": [ "typeof ", { @@ -21688,18 +24279,20 @@ "section": "def-common.StringFormat", "text": "StringFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 115 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.TruncateFormat", "type": "Object", + "tags": [], "label": "TruncateFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 116 - }, "signature": [ "typeof ", { @@ -21709,18 +24302,20 @@ "section": "def-common.TruncateFormat", "text": "TruncateFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 116 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.fieldFormats.HistogramFormat", "type": "Object", + "tags": [], "label": "HistogramFormat", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 117 - }, "signature": [ "typeof ", { @@ -21730,32 +24325,36 @@ "section": "def-common.HistogramFormat", "text": "HistogramFormat" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 117 + }, + "deprecated": false } ], - "description": [], - "label": "fieldFormats", - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 101 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.indexPatterns", "type": "Object", "tags": [], + "label": "indexPatterns", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 128 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.indexPatterns.isFilterable", "type": "Function", + "tags": [], "label": "isFilterable", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 129 - }, "signature": [ "typeof ", { @@ -21765,18 +24364,20 @@ "section": "def-common.isFilterable", "text": "isFilterable" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 129 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.indexPatterns.isNestedField", "type": "Function", + "tags": [], "label": "isNestedField", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 130 - }, "signature": [ "typeof ", { @@ -21786,37 +24387,49 @@ "section": "def-common.isNestedField", "text": "isNestedField" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 130 + }, + "deprecated": false } ], - "description": [], - "label": "indexPatterns", - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 128 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.search", "type": "Object", "tags": [], + "label": "search", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 243 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.search.aggs", "type": "Object", "tags": [], + "label": "aggs", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 244 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.CidrMask", "type": "Object", + "tags": [], "label": "CidrMask", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 246 - }, "signature": [ "typeof ", { @@ -21826,18 +24439,20 @@ "section": "def-common.CidrMask", "text": "CidrMask" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 245 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.dateHistogramInterval", "type": "Function", + "tags": [], "label": "dateHistogramInterval", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 247 - }, "signature": [ "typeof ", { @@ -21847,18 +24462,20 @@ "section": "def-common.dateHistogramInterval", "text": "dateHistogramInterval" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 246 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.intervalOptions", "type": "Array", + "tags": [], "label": "intervalOptions", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 248 - }, "signature": [ "({ display: string; val: string; enabled(agg: ", { @@ -21869,18 +24486,20 @@ "text": "IBucketAggConfig" }, "): boolean; } | { display: string; val: string; })[]" - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 247 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.InvalidEsCalendarIntervalError", "type": "Object", + "tags": [], "label": "InvalidEsCalendarIntervalError", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 249 - }, "signature": [ "typeof ", { @@ -21890,18 +24509,20 @@ "section": "def-common.InvalidEsCalendarIntervalError", "text": "InvalidEsCalendarIntervalError" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 248 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.InvalidEsIntervalFormatError", "type": "Object", + "tags": [], "label": "InvalidEsIntervalFormatError", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 250 - }, "signature": [ "typeof ", { @@ -21911,18 +24532,20 @@ "section": "def-common.InvalidEsIntervalFormatError", "text": "InvalidEsIntervalFormatError" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 249 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.Ipv4Address", "type": "Object", + "tags": [], "label": "Ipv4Address", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 251 - }, "signature": [ "typeof ", { @@ -21932,18 +24555,20 @@ "section": "def-common.Ipv4Address", "text": "Ipv4Address" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 250 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.isNumberType", "type": "Function", + "tags": [], "label": "isNumberType", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 252 - }, "signature": [ "(agg: ", { @@ -21954,18 +24579,20 @@ "text": "AggConfig" }, ") => boolean" - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 251 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.isStringType", "type": "Function", + "tags": [], "label": "isStringType", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 253 - }, "signature": [ "(agg: ", { @@ -21976,18 +24603,20 @@ "text": "AggConfig" }, ") => boolean" - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 252 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.isType", "type": "Function", + "tags": [], "label": "isType", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 254 - }, "signature": [ "(...types: string[]) => (agg: ", { @@ -21998,18 +24627,20 @@ "text": "AggConfig" }, ") => boolean" - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 253 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.isValidEsInterval", "type": "Function", + "tags": [], "label": "isValidEsInterval", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 255 - }, "signature": [ "typeof ", { @@ -22019,18 +24650,20 @@ "section": "def-common.isValidEsInterval", "text": "isValidEsInterval" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 254 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.isValidInterval", "type": "Function", + "tags": [], "label": "isValidInterval", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 256 - }, "signature": [ "typeof ", { @@ -22040,29 +24673,33 @@ "section": "def-common.isValidInterval", "text": "isValidInterval" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 255 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.parentPipelineType", "type": "string", + "tags": [], "label": "parentPipelineType", "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 257 - } + "lineNumber": 256 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.parseEsInterval", "type": "Function", + "tags": [], "label": "parseEsInterval", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 258 - }, "signature": [ "typeof ", { @@ -22072,18 +24709,20 @@ "section": "def-common.parseEsInterval", "text": "parseEsInterval" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 257 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.parseInterval", "type": "Function", + "tags": [], "label": "parseInterval", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 259 - }, "signature": [ "typeof ", { @@ -22093,18 +24732,20 @@ "section": "def-common.parseInterval", "text": "parseInterval" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 258 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.propFilter", "type": "Function", + "tags": [], "label": "propFilter", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 260 - }, "signature": [ "typeof ", { @@ -22114,43 +24755,49 @@ "section": "def-common.propFilter", "text": "propFilter" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 259 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.siblingPipelineType", "type": "string", + "tags": [], "label": "siblingPipelineType", "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 261 - } + "lineNumber": 260 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.termsAggFilter", "type": "Array", + "tags": [], "label": "termsAggFilter", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 262 + "lineNumber": 261 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.toAbsoluteDates", "type": "Function", + "tags": [], "label": "toAbsoluteDates", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 263 - }, "signature": [ "typeof ", { @@ -22160,18 +24807,20 @@ "section": "def-common.toAbsoluteDates", "text": "toAbsoluteDates" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 262 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.aggs.calcAutoIntervalLessThan", "type": "Function", + "tags": [], "label": "calcAutoIntervalLessThan", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 264 - }, "signature": [ "typeof ", { @@ -22181,68 +24830,22 @@ "section": "def-common.calcAutoIntervalLessThan", "text": "calcAutoIntervalLessThan" } - ] - } - ], - "description": [], - "label": "aggs", - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 245 - } - }, - { - "tags": [], - "id": "def-server.search.getRequestInspectorStats", - "type": "Function", - "label": "getRequestInspectorStats", - "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 266 - }, - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.getRequestInspectorStats", - "text": "getRequestInspectorStats" - } - ] - }, - { - "tags": [], - "id": "def-server.search.getResponseInspectorStats", - "type": "Function", - "label": "getResponseInspectorStats", - "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 267 - }, - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.getResponseInspectorStats", - "text": "getResponseInspectorStats" + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 263 + }, + "deprecated": false } ] }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.tabifyAggResponse", "type": "Function", + "tags": [], "label": "tabifyAggResponse", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 268 - }, "signature": [ "typeof ", { @@ -22252,18 +24855,20 @@ "section": "def-common.tabifyAggResponse", "text": "tabifyAggResponse" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 265 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.tabifyGetColumns", "type": "Function", + "tags": [], "label": "tabifyGetColumns", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 269 - }, "signature": [ "typeof ", { @@ -22273,50 +24878,54 @@ "section": "def-common.tabifyGetColumns", "text": "tabifyGetColumns" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 266 + }, + "deprecated": false } ], - "description": [], - "label": "search", - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 244 - }, "initialIsOpen": false }, { - "tags": [], + "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 COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; 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 SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }" + ], "source": { "path": "src/plugins/data/common/constants.ts", "lineNumber": 12 }, - "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 COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; 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 SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }" - ], + "deprecated": false, "initialIsOpen": false } ], "setup": { + "parentPluginId": "data", "id": "def-server.DataPluginSetup", "type": "Interface", + "tags": [], "label": "DataPluginSetup", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.DataPluginSetup.search", "type": "Object", + "tags": [], "label": "search", "description": [], - "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 29 - }, "signature": [ { "pluginId": "data", @@ -22325,49 +24934,55 @@ "section": "def-server.ISearchSetup", "text": "ISearchSetup" } - ] + ], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.DataPluginSetup.fieldFormats", "type": "Object", + "tags": [], "label": "fieldFormats", "description": [], - "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 30 - }, "signature": [ "{ register: (customFieldFormat: ", "FieldFormatInstanceType", ") => number; }" - ] + ], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 30 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 28 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "data", "id": "def-server.DataPluginStart", "type": "Interface", + "tags": [], "label": "DataPluginStart", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.DataPluginStart.search", "type": "Object", + "tags": [], "label": "search", "description": [], - "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 38 - }, "signature": [ { "pluginId": "data", @@ -22393,18 +25008,20 @@ "text": "IEsSearchResponse" }, ">" - ] + ], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 38 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.DataPluginStart.fieldFormats", "type": "Object", + "tags": [], "label": "fieldFormats", "description": [], - "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 39 - }, "signature": [ "{ fieldFormatServiceFactory: (uiSettings: ", { @@ -22423,27 +25040,30 @@ "text": "FieldFormatsRegistry" }, ">; }" - ] + ], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 39 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.DataPluginStart.indexPatterns", "type": "Object", + "tags": [], "label": "indexPatterns", "description": [], + "signature": [ + "IndexPatternsServiceStart" + ], "source": { "path": "src/plugins/data/server/plugin.ts", "lineNumber": 40 }, - "signature": [ - "IndexPatternsServiceStart" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 37 - }, "lifecycle": "start", "initialIsOpen": true } @@ -22451,55 +25071,64 @@ "common": { "classes": [ { + "parentPluginId": "data", "id": "def-common.KbnFieldType", "type": "Class", "tags": [], "label": "KbnFieldType", "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.KbnFieldType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KbnFieldType.sortable", "type": "boolean", + "tags": [], "label": "sortable", "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KbnFieldType.filterable", "type": "boolean", + "tags": [], "label": "filterable", "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KbnFieldType.esTypes", "type": "Object", + "tags": [], "label": "esTypes", "description": [], - "source": { - "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", - "lineNumber": 15 - }, "signature": [ "readonly ", { @@ -22510,22 +25139,36 @@ "text": "ES_FIELD_TYPES" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 15 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.KbnFieldType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.KbnFieldType.Unnamed.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ "Partial<", { @@ -22537,28 +25180,21 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", - "lineNumber": 17 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KQLSyntaxError", "type": "Class", "tags": [], @@ -22574,76 +25210,90 @@ }, " extends Error" ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.KQLSyntaxError.shortMessage", "type": "string", + "tags": [], "label": "shortMessage", "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", "lineNumber": 42 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.KQLSyntaxError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.KQLSyntaxError.Unnamed.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "KQLSyntaxErrorData" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", "lineNumber": 44 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.KQLSyntaxError.Unnamed.$2", "type": "Any", + "tags": [], "label": "expression", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", "lineNumber": 44 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", - "lineNumber": 44 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", - "lineNumber": 41 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "data", "id": "def-common.buildCustomFilter", "type": "Function", + "tags": [], "label": "buildCustomFilter", + "description": [], "signature": [ "(indexPatternString: string, queryDsl: any, disabled: boolean, negate: boolean, alias: string | null, store: ", { @@ -22662,83 +25312,104 @@ "text": "Filter" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.buildCustomFilter.$1", "type": "string", + "tags": [], "label": "indexPatternString", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildCustomFilter.$2", "type": "Any", + "tags": [], "label": "queryDsl", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildCustomFilter.$3", "type": "boolean", + "tags": [], "label": "disabled", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 44 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildCustomFilter.$4", "type": "boolean", + "tags": [], "label": "negate", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildCustomFilter.$5", "type": "CompoundType", + "tags": [], "label": "alias", - "isRequired": false, + "description": [], "signature": [ "string | null" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.buildCustomFilter.$6", "type": "Enum", + "tags": [], "label": "store", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -22748,78 +25419,85 @@ "text": "FilterStateStore" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/build_filters.ts", - "lineNumber": 41 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.buildEmptyFilter", "type": "Function", + "tags": [], + "label": "buildEmptyFilter", + "description": [], + "signature": [ + "(isPinned: boolean, index?: string | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 52 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.buildEmptyFilter.$1", "type": "boolean", + "tags": [], "label": "isPinned", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 52 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildEmptyFilter.$2", "type": "string", + "tags": [], "label": "index", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 52 - } - } - ], - "signature": [ - "(isPinned: boolean, index?: string | undefined) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + }, + "deprecated": false, + "isRequired": false } ], - "description": [], - "label": "buildEmptyFilter", - "source": { - "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 52 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.buildEsQuery", "type": "Function", + "tags": [], "label": "buildEsQuery", + "description": [], "signature": [ "(indexPattern: ", { @@ -22862,13 +25540,19 @@ "text": "Filter" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.buildEsQuery.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -22879,17 +25563,22 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.buildEsQuery.$2", "type": "CompoundType", + "tags": [], "label": "queries", - "isRequired": true, + "description": [ + "- a query object or array of query objects. Each query has a language property and a query property." + ], "signature": [ { "pluginId": "data", @@ -22908,19 +25597,22 @@ }, "[]" ], - "description": [ - "- a query object or array of query objects. Each query has a language property and a query property." - ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildEsQuery.$3", "type": "CompoundType", + "tags": [], "label": "filters", - "isRequired": true, + "description": [ + "- a filter object or array of filter objects" + ], "signature": [ { "pluginId": "data", @@ -22939,19 +25631,22 @@ }, "[]" ], - "description": [ - "- a filter object or array of filter objects" - ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildEsQuery.$4", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [ + "- an objects with query:allowLeadingWildcards and query:queryString:options UI\nsettings in form of { allowLeadingWildcards, queryStringOptions }\nconfig contains dateformat:tz" + ], "signature": [ { "pluginId": "data", @@ -22961,32 +25656,63 @@ "text": "EsQueryConfig" } ], - "description": [ - "- an objects with query:allowLeadingWildcards and query:queryString:options UI\nsettings in form of { allowLeadingWildcards, queryStringOptions }\nconfig contains dateformat:tz" - ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", - "lineNumber": 32 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.buildExistsFilter", "type": "Function", + "tags": [], + "label": "buildExistsFilter", + "description": [], + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.buildExistsFilter.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -22996,17 +25722,20 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildExistsFilter.$2", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23016,53 +25745,24 @@ "text": "IIndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", "lineNumber": 29 - } - } - ], - "signature": [ - "(field: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ", indexPattern: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ExistsFilter", - "text": "ExistsFilter" + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "buildExistsFilter", - "source": { - "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", - "lineNumber": 29 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.buildFilter", "type": "Function", + "tags": [], "label": "buildFilter", + "description": [], "signature": [ "(indexPattern: ", { @@ -23105,13 +25805,19 @@ "text": "Filter" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.buildFilter.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23121,17 +25827,20 @@ "text": "IIndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildFilter.$2", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23141,17 +25850,20 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildFilter.$3", "type": "Enum", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23161,73 +25873,88 @@ "text": "FILTERS" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildFilter.$4", "type": "boolean", + "tags": [], "label": "negate", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildFilter.$5", "type": "boolean", + "tags": [], "label": "disabled", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildFilter.$6", "type": "Any", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildFilter.$7", "type": "CompoundType", + "tags": [], "label": "alias", - "isRequired": false, + "description": [], "signature": [ "string | null" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.buildFilter.$8", "type": "CompoundType", + "tags": [], "label": "store", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -23238,30 +25965,63 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/build_filters.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/build_filters.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.buildPhraseFilter", "type": "Function", + "tags": [], + "label": "buildPhraseFilter", + "description": [], + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", value: any, indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.buildPhraseFilter.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23271,31 +26031,37 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildPhraseFilter.$2", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 62 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildPhraseFilter.$3", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23305,13 +26071,24 @@ "text": "IIndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 63 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.buildPhrasesFilter", + "type": "Function", + "tags": [], + "label": "buildPhrasesFilter", + "description": [], "signature": [ "(field: ", { @@ -23321,7 +26098,7 @@ "section": "def-common.IFieldType", "text": "IFieldType" }, - ", value: any, indexPattern: ", + ", params: any[], indexPattern: ", { "pluginId": "data", "scope": "common", @@ -23334,29 +26111,23 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhraseFilter", - "text": "PhraseFilter" + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" } ], - "description": [], - "label": "buildPhraseFilter", "source": { - "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", - "lineNumber": 60 + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 34 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.buildPhrasesFilter", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.buildPhrasesFilter.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23366,31 +26137,37 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildPhrasesFilter.$2", "type": "Array", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "any[]" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildPhrasesFilter.$3", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23400,125 +26177,150 @@ "text": "IIndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", "lineNumber": 37 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.buildQueryFilter", + "type": "Function", + "tags": [], + "label": "buildQueryFilter", + "description": [], "signature": [ - "(field: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ", params: any[], indexPattern: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - ") => ", + "(query: any, index: string, alias: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhrasesFilter", - "text": "PhrasesFilter" + "section": "def-common.QueryStringFilter", + "text": "QueryStringFilter" } ], - "description": [], - "label": "buildPhrasesFilter", "source": { - "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", - "lineNumber": 34 + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.buildQueryFilter", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.buildQueryFilter.$1", "type": "Any", + "tags": [], "label": "query", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildQueryFilter.$2", "type": "string", + "tags": [], "label": "index", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildQueryFilter.$3", "type": "string", + "tags": [], "label": "alias", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.buildQueryFromFilters", + "type": "Function", + "tags": [], + "label": "buildQueryFromFilters", + "description": [], "signature": [ - "(query: any, index: string, alias: string) => ", + "(filters: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.QueryStringFilter", - "text": "QueryStringFilter" - } - ], - "description": [], - "label": "buildQueryFilter", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined, indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => { must: never[]; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; should: never[]; must_not: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; }" + ], "source": { - "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", - "lineNumber": 26 + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 46 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.buildQueryFromFilters", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.buildQueryFromFilters.$1", "type": "Array", + "tags": [], "label": "filters", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23529,17 +26331,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildQueryFromFilters.$2", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -23550,81 +26355,88 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", "lineNumber": 48 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.buildQueryFromFilters.$3", "type": "boolean", + "tags": [], "label": "ignoreFilterIfFieldNotInIndex", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.buildRangeFilter", + "type": "Function", + "tags": [], + "label": "buildRangeFilter", + "description": [], "signature": [ - "(filters: ", + "(field: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" }, - "[] | undefined, indexPattern: ", + ", params: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" }, - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => { must: never[]; filter: ", + ", indexPattern: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" }, - "[]; should: never[]; must_not: ", + ", formattedValue?: string | undefined) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]; }" + "section": "def-common.RangeFilter", + "text": "RangeFilter" + } ], - "description": [], - "label": "buildQueryFromFilters", "source": { - "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", - "lineNumber": 46 + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 93 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.buildRangeFilter", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.buildRangeFilter.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23634,17 +26446,20 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 94 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildRangeFilter.$2", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23654,17 +26469,20 @@ "text": "RangeFilterParams" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 95 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildRangeFilter.$3", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23674,123 +26492,122 @@ "text": "IIndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 96 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.buildRangeFilter.$4", "type": "string", + "tags": [], "label": "formattedValue", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 97 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.castEsToKbnFieldTypeName", + "type": "Function", + "tags": [ + "return" + ], + "label": "castEsToKbnFieldTypeName", + "description": [ + "\n Get the KbnFieldType name for an esType string\n" + ], "signature": [ - "(field: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ", params: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.RangeFilterParams", - "text": "RangeFilterParams" - }, - ", indexPattern: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - ", formattedValue?: string | undefined) => ", + "(esType: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.RangeFilter", - "text": "RangeFilter" + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" } ], - "description": [], - "label": "buildRangeFilter", "source": { - "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 93 + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 39 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.castEsToKbnFieldTypeName", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.castEsToKbnFieldTypeName.$1", "type": "string", + "tags": [], "label": "esType", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.cleanFilter", + "type": "Function", + "tags": [], + "label": "cleanFilter", + "description": [ + "\nClean out any invalid attributes from the filters" + ], "signature": [ - "(esType: string) => ", + "(filter: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" + "section": "def-common.Filter", + "text": "Filter" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" } ], - "description": [ - "\n Get the KbnFieldType name for an esType string\n" - ], - "label": "castEsToKbnFieldTypeName", "source": { - "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", - "lineNumber": 39 + "path": "src/plugins/data/common/es_query/filters/index.ts", + "lineNumber": 36 }, - "tags": [ - "return" - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.cleanFilter", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.cleanFilter.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23800,51 +26617,28 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/index.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.datatableToCSV", + "type": "Function", + "tags": [], + "label": "datatableToCSV", + "description": [], "signature": [ - "(filter: ", + "({ columns, rows }: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - } - ], - "description": [ - "\nClean out any invalid attributes from the filters" - ], - "label": "cleanFilter", - "source": { - "path": "src/plugins/data/common/es_query/filters/index.ts", - "lineNumber": 36 - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.datatableToCSV", - "type": "Function", - "label": "datatableToCSV", - "signature": [ - "({ columns, rows }: ", - { - "pluginId": "expressions", + "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", @@ -23852,13 +26646,19 @@ }, ", { csvSeparator, quoteValues, formatFactory, raw }: CSVOptions) => string" ], - "description": [], + "source": { + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.datatableToCSV.$1", "type": "Object", + "tags": [], "label": "{ columns, rows }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -23868,39 +26668,43 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/data/common/exports/export_csv.tsx", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.datatableToCSV.$2", "type": "Object", + "tags": [], "label": "{ csvSeparator, quoteValues, formatFactory, raw }", - "isRequired": true, + "description": [], "signature": [ "CSVOptions" ], - "description": [], "source": { "path": "src/plugins/data/common/exports/export_csv.tsx", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/exports/export_csv.tsx", - "lineNumber": 41 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.decorateQuery", "type": "Function", + "tags": [], "label": "decorateQuery", + "description": [ + "\nDecorate queries with default parameters" + ], "signature": [ "(query: ", { @@ -23919,15 +26723,21 @@ "text": "DslQuery" } ], - "description": [ - "\nDecorate queries with default parameters" - ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.decorateQuery.$1", "type": "CompoundType", + "tags": [], "label": "query", - "isRequired": true, + "description": [ + "object" + ], "signature": [ { "pluginId": "data", @@ -23937,64 +26747,93 @@ "text": "DslQuery" } ], - "description": [ - "object" - ], "source": { "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.decorateQuery.$2", "type": "CompoundType", + "tags": [], "label": "queryStringOptions", - "isRequired": true, - "signature": [ - "string | Record" - ], "description": [ "query:queryString:options from UI settings" ], + "signature": [ + "string | Record" + ], "source": { "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.decorateQuery.$3", "type": "string", + "tags": [], "label": "dateFormatTZ", - "isRequired": false, - "signature": [ - "string | undefined" - ], "description": [ "dateFormat:tz from UI settings" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.disableFilter", "type": "Function", + "tags": [], + "label": "disableFilter", + "description": [], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 94 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.disableFilter.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24004,13 +26843,24 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 94 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.enableFilter", + "type": "Function", + "tags": [], + "label": "enableFilter", + "description": [], "signature": [ "(filter: ", { @@ -24029,25 +26879,19 @@ "text": "Filter" } ], - "description": [], - "label": "disableFilter", "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 94 + "lineNumber": 91 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.enableFilter", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.enableFilter.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24057,64 +26901,72 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 91 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.fromKueryExpression", + "type": "Function", + "tags": [], + "label": "fromKueryExpression", + "description": [], "signature": [ - "(filter: ", + "(expression: any, parseOptions?: Partial<", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.KueryParseOptions", + "text": "KueryParseOptions" }, - ") => ", + ">) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.KueryNode", + "text": "KueryNode" } ], - "description": [], - "label": "enableFilter", "source": { - "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 91 + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 44 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.fromKueryExpression", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.fromKueryExpression.$1", "type": "Any", + "tags": [], "label": "expression", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.fromKueryExpression.$2", "type": "Object", + "tags": [], "label": "parseOptions", - "isRequired": true, + "description": [], "signature": [ "Partial<", { @@ -24126,13 +26978,24 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.fromLiteralExpression", + "type": "Function", + "tags": [], + "label": "fromLiteralExpression", + "description": [], "signature": [ "(expression: any, parseOptions?: Partial<", { @@ -24151,39 +27014,36 @@ "text": "KueryNode" } ], - "description": [], - "label": "fromKueryExpression", "source": { "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", - "lineNumber": 44 + "lineNumber": 30 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.fromLiteralExpression", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.fromLiteralExpression.$1", "type": "Any", + "tags": [], "label": "expression", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.fromLiteralExpression.$2", "type": "Object", + "tags": [], "label": "parseOptions", - "isRequired": true, + "description": [], "signature": [ "Partial<", { @@ -24195,45 +27055,24 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", "lineNumber": 32 - } - } - ], - "signature": [ - "(expression: any, parseOptions?: Partial<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KueryParseOptions", - "text": "KueryParseOptions" - }, - ">) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KueryNode", - "text": "KueryNode" + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "fromLiteralExpression", - "source": { - "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", - "lineNumber": 30 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getDisplayValueFromFilter", "type": "Function", + "tags": [], "label": "getDisplayValueFromFilter", + "description": [], "signature": [ "(filter: ", { @@ -24253,13 +27092,19 @@ }, "[]) => string" ], - "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getDisplayValueFromFilter.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24269,17 +27114,20 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.getDisplayValueFromFilter.$2", "type": "Array", + "tags": [], "label": "indexPatterns", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24290,25 +27138,24 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getEsQueryConfig", "type": "Function", + "tags": [], "label": "getEsQueryConfig", + "description": [], "signature": [ "(config: KibanaConfig) => ", { @@ -24319,40 +27166,64 @@ "text": "EsQueryConfig" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getEsQueryConfig.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "KibanaConfig" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getExistsFilterField", "type": "Function", + "tags": [], + "label": "getExistsFilterField", + "description": [], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" + }, + ") => any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getExistsFilterField.$1", "type": "CompoundType", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24362,64 +27233,71 @@ "text": "ExistsFilter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(filter: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ExistsFilter", - "text": "ExistsFilter" - }, - ") => any" - ], - "description": [], - "label": "getExistsFilterField", - "source": { - "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", - "lineNumber": 25 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getFilterableKbnTypeNames", "type": "Function", - "children": [], - "signature": [ - "() => string[]" + "tags": [ + "return" ], + "label": "getFilterableKbnTypeNames", "description": [ "\n Get filterable KbnFieldTypes\n" ], - "label": "getFilterableKbnTypeNames", + "signature": [ + "() => string[]" + ], "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", "lineNumber": 50 }, - "tags": [ - "return" - ], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getFilterField", "type": "Function", + "tags": [], + "label": "getFilterField", + "description": [], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_filter_field.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getFilterField.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24429,38 +27307,24 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/get_filter_field.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(filter: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - ") => any" - ], - "description": [], - "label": "getFilterField", - "source": { - "path": "src/plugins/data/common/es_query/filters/get_filter_field.ts", - "lineNumber": 18 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getFilterParams", "type": "Function", + "tags": [], "label": "getFilterParams", + "description": [], "signature": [ "(filter: ", { @@ -24472,13 +27336,19 @@ }, ") => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_filter_params.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getFilterParams.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24488,30 +27358,48 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/get_filter_params.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/get_filter_params.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getGeoBoundingBoxFilterField", "type": "Function", + "tags": [], + "label": "getGeoBoundingBoxFilterField", + "description": [], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GeoBoundingBoxFilter", + "text": "GeoBoundingBoxFilter" + }, + ") => any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getGeoBoundingBoxFilterField.$1", "type": "CompoundType", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24521,43 +27409,48 @@ "text": "GeoBoundingBoxFilter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getGeoPolygonFilterField", + "type": "Function", + "tags": [], + "label": "getGeoPolygonFilterField", + "description": [], "signature": [ "(filter: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.GeoBoundingBoxFilter", - "text": "GeoBoundingBoxFilter" + "section": "def-common.GeoPolygonFilter", + "text": "GeoPolygonFilter" }, ") => any" ], - "description": [], - "label": "getGeoBoundingBoxFilterField", "source": { - "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", - "lineNumber": 26 + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 25 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getGeoPolygonFilterField", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getGeoPolygonFilterField.$1", "type": "CompoundType", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24567,38 +27460,24 @@ "text": "GeoPolygonFilter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(filter: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GeoPolygonFilter", - "text": "GeoPolygonFilter" - }, - ") => any" - ], - "description": [], - "label": "getGeoPolygonFilterField", - "source": { - "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", - "lineNumber": 25 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getIndexPatternFromFilter", "type": "Function", + "tags": [], "label": "getIndexPatternFromFilter", + "description": [], "signature": [ "(filter: ", { @@ -24626,13 +27505,19 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getIndexPatternFromFilter.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24642,17 +27527,20 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.getIndexPatternFromFilter.$2", "type": "Array", + "tags": [], "label": "indexPatterns", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24663,43 +27551,31 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getKbnFieldType", "type": "Function", - "children": [ - { - "id": "def-common.getKbnFieldType.$1", - "type": "string", - "label": "typeName", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", - "lineNumber": 22 - } - } + "tags": [ + "return" ], - "signature": [ - "(typeName: string) => ", - { + "label": "getKbnFieldType", + "description": [ + "\n Get a type object by name\n" + ], + "signature": [ + "(typeName: string) => ", + { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", @@ -24707,50 +27583,87 @@ "text": "KbnFieldType" } ], - "description": [ - "\n Get a type object by name\n" - ], - "label": "getKbnFieldType", "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", "lineNumber": 22 }, - "tags": [ - "return" + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getKbnFieldType.$1", + "type": "string", + "tags": [], + "label": "typeName", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 22 + }, + "deprecated": false, + "isRequired": true + } ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getKbnTypeNames", "type": "Function", - "children": [], - "signature": [ - "() => string[]" + "tags": [ + "return" ], + "label": "getKbnTypeNames", "description": [ "\n Get the esTypes known by all kbnFieldTypes\n" ], - "label": "getKbnTypeNames", + "signature": [ + "() => string[]" + ], "source": { "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", "lineNumber": 30 }, - "tags": [ - "return" - ], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getMissingFilterField", "type": "Function", + "tags": [], + "label": "getMissingFilterField", + "description": [], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MissingFilter", + "text": "MissingFilter" + }, + ") => any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getMissingFilterField.$1", "type": "CompoundType", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24760,43 +27673,48 @@ "text": "MissingFilter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getPhraseFilterField", + "type": "Function", + "tags": [], + "label": "getPhraseFilterField", + "description": [], "signature": [ "(filter: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.MissingFilter", - "text": "MissingFilter" + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" }, - ") => any" + ") => string" ], - "description": [], - "label": "getMissingFilterField", "source": { - "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", - "lineNumber": 20 + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 49 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getPhraseFilterField", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getPhraseFilterField.$1", "type": "CompoundType", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24806,13 +27724,24 @@ "text": "PhraseFilter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getPhraseFilterValue", + "type": "Function", + "tags": [], + "label": "getPhraseFilterValue", + "description": [], "signature": [ "(filter: ", { @@ -24822,27 +27751,21 @@ "section": "def-common.PhraseFilter", "text": "PhraseFilter" }, - ") => string" + ") => PhraseFilterValue" ], - "description": [], - "label": "getPhraseFilterField", "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", - "lineNumber": 49 + "lineNumber": 54 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getPhraseFilterValue", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getPhraseFilterValue.$1", "type": "CompoundType", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24852,43 +27775,48 @@ "text": "PhraseFilter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getPhraseScript", + "type": "Function", + "tags": [], + "label": "getPhraseScript", + "description": [], "signature": [ - "(filter: ", + "(field: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.PhraseFilter", - "text": "PhraseFilter" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" }, - ") => PhraseFilterValue" + ", value: string) => { script: { source: string; lang: string | undefined; params: { value: any; }; }; }" ], - "description": [], - "label": "getPhraseFilterValue", "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", - "lineNumber": 54 + "lineNumber": 84 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getPhraseScript", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getPhraseScript.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24898,57 +27826,65 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 84 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.getPhraseScript.$2", "type": "string", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 84 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getPhrasesFilterField", + "type": "Function", + "tags": [], + "label": "getPhrasesFilterField", + "description": [], "signature": [ - "(field: ", + "(filter: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" }, - ", value: string) => { script: { source: string; lang: string | undefined; params: { value: any; }; }; }" + ") => string | undefined" ], - "description": [], - "label": "getPhraseScript", "source": { - "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", - "lineNumber": 84 + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 26 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getPhrasesFilterField", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getPhrasesFilterField.$1", "type": "CompoundType", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -24958,43 +27894,48 @@ "text": "PhrasesFilter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getRangeFilterField", + "type": "Function", + "tags": [], + "label": "getRangeFilterField", + "description": [], "signature": [ "(filter: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhrasesFilter", - "text": "PhrasesFilter" + "section": "def-common.RangeFilter", + "text": "RangeFilter" }, - ") => string | undefined" + ") => string" ], - "description": [], - "label": "getPhrasesFilterField", "source": { - "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", - "lineNumber": 26 + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 81 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getRangeFilterField", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getRangeFilterField.$1", "type": "CompoundType", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -25004,43 +27945,64 @@ "text": "RangeFilter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(filter: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.RangeFilter", - "text": "RangeFilter" - }, - ") => string" - ], - "description": [], - "label": "getRangeFilterField", - "source": { - "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 81 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getRangeScript", "type": "Function", - "children": [ - { - "id": "def-common.getRangeScript.$1", + "tags": [], + "label": "getRangeScript", + "description": [], + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", params: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + }, + ") => { script: { source: string; params: Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + }, + ">; lang: string | undefined; }; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 140 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getRangeScript.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -25050,17 +28012,20 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 140 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.getRangeScript.$2", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -25070,137 +28035,136 @@ "text": "RangeFilterParams" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 140 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isExistsFilter", + "type": "Function", + "tags": [], + "label": "isExistsFilter", + "description": [], "signature": [ - "(field: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ", params: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.RangeFilterParams", - "text": "RangeFilterParams" - }, - ") => { script: { source: string; params: Partial<", + "(filter: any) => filter is ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.RangeFilterParams", - "text": "RangeFilterParams" - }, - ">; lang: string | undefined; }; }" + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" + } ], - "description": [], - "label": "getRangeScript", "source": { - "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 140 + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 23 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isExistsFilter", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isExistsFilter.$1", "type": "Any", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isFilter", + "type": "Function", + "tags": [], + "label": "isFilter", + "description": [], "signature": [ - "(filter: any) => filter is ", + "(x: unknown) => x is ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.ExistsFilter", - "text": "ExistsFilter" + "section": "def-common.Filter", + "text": "Filter" } ], - "description": [], - "label": "isExistsFilter", "source": { - "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", - "lineNumber": 23 + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 103 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isFilter", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isFilter.$1", "type": "Unknown", + "tags": [], "label": "x", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 103 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isFilterDisabled", + "type": "Function", + "tags": [], + "label": "isFilterDisabled", + "description": [], "signature": [ - "(x: unknown) => x is ", + "(filter: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.Filter", "text": "Filter" - } + }, + ") => boolean" ], - "description": [], - "label": "isFilter", "source": { - "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 103 + "path": "src/plugins/data/common/es_query/filters/index.ts", + "lineNumber": 38 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isFilterDisabled", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isFilterDisabled.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -25210,13 +28174,24 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/index.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isFilterPinned", + "type": "Function", + "tags": [], + "label": "isFilterPinned", + "description": [], "signature": [ "(filter: ", { @@ -25226,27 +28201,21 @@ "section": "def-common.Filter", "text": "Filter" }, - ") => boolean" + ") => boolean | undefined" ], - "description": [], - "label": "isFilterDisabled", "source": { - "path": "src/plugins/data/common/es_query/filters/index.ts", - "lineNumber": 38 + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 66 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isFilterPinned", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isFilterPinned.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -25256,15 +28225,26 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 66 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isFilters", + "type": "Function", + "tags": [], + "label": "isFilters", + "description": [], "signature": [ - "(filter: ", + "(x: unknown) => x is ", { "pluginId": "data", "scope": "common", @@ -25272,77 +28252,42 @@ "section": "def-common.Filter", "text": "Filter" }, - ") => boolean | undefined" + "[]" ], - "description": [], - "label": "isFilterPinned", "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 66 + "lineNumber": 110 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isFilters", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isFilters.$1", "type": "Unknown", + "tags": [], "label": "x", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 110 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(x: unknown) => x is ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]" - ], - "description": [], - "label": "isFilters", - "source": { - "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 110 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isGeoBoundingBoxFilter", "type": "Function", - "children": [ - { - "id": "def-common.isGeoBoundingBoxFilter.$1", - "type": "Any", - "label": "filter", - "isRequired": true, - "signature": [ - "any" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", - "lineNumber": 23 - } - } - ], + "tags": [], + "label": "isGeoBoundingBoxFilter", + "description": [], "signature": [ "(filter: any) => filter is ", { @@ -25353,35 +28298,40 @@ "text": "GeoBoundingBoxFilter" } ], - "description": [], - "label": "isGeoBoundingBoxFilter", "source": { "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", "lineNumber": 23 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isGeoPolygonFilter", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.isGeoPolygonFilter.$1", + "parentPluginId": "data", + "id": "def-common.isGeoBoundingBoxFilter.$1", "type": "Any", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { - "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", - "lineNumber": 22 - } + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 23 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isGeoPolygonFilter", + "type": "Function", + "tags": [], + "label": "isGeoPolygonFilter", + "description": [], "signature": [ "(filter: any) => filter is ", { @@ -25392,35 +28342,40 @@ "text": "GeoPolygonFilter" } ], - "description": [], - "label": "isGeoPolygonFilter", "source": { "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", "lineNumber": 22 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isMatchAllFilter", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.isMatchAllFilter.$1", + "parentPluginId": "data", + "id": "def-common.isGeoPolygonFilter.$1", "type": "Any", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { - "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", - "lineNumber": 21 - } + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 22 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isMatchAllFilter", + "type": "Function", + "tags": [], + "label": "isMatchAllFilter", + "description": [], "signature": [ "(filter: any) => filter is ", { @@ -25431,35 +28386,40 @@ "text": "MatchAllFilter" } ], - "description": [], - "label": "isMatchAllFilter", "source": { "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", "lineNumber": 21 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isMissingFilter", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.isMissingFilter.$1", + "parentPluginId": "data", + "id": "def-common.isMatchAllFilter.$1", "type": "Any", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { - "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", - "lineNumber": 18 - } + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 21 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isMissingFilter", + "type": "Function", + "tags": [], + "label": "isMissingFilter", + "description": [], "signature": [ "(filter: any) => filter is ", { @@ -25470,35 +28430,40 @@ "text": "MissingFilter" } ], - "description": [], - "label": "isMissingFilter", "source": { "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", "lineNumber": 18 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isPhraseFilter", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.isPhraseFilter.$1", + "parentPluginId": "data", + "id": "def-common.isMissingFilter.$1", "type": "Any", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { - "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", - "lineNumber": 34 - } + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 18 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isPhraseFilter", + "type": "Function", + "tags": [], + "label": "isPhraseFilter", + "description": [], "signature": [ "(filter: any) => filter is ", { @@ -25509,35 +28474,40 @@ "text": "PhraseFilter" } ], - "description": [], - "label": "isPhraseFilter", "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 34 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isPhrasesFilter", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.isPhrasesFilter.$1", + "parentPluginId": "data", + "id": "def-common.isPhraseFilter.$1", "type": "Any", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { - "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", - "lineNumber": 23 - } + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 34 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isPhrasesFilter", + "type": "Function", + "tags": [], + "label": "isPhrasesFilter", + "description": [], "signature": [ "(filter: any) => filter is ", { @@ -25548,35 +28518,40 @@ "text": "PhrasesFilter" } ], - "description": [], - "label": "isPhrasesFilter", - "source": { - "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", - "lineNumber": 23 - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isQueryStringFilter", - "type": "Function", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "id": "def-common.isQueryStringFilter.$1", + "parentPluginId": "data", + "id": "def-common.isPhrasesFilter.$1", "type": "Any", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { - "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", - "lineNumber": 22 - } + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 23 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isQueryStringFilter", + "type": "Function", + "tags": [], + "label": "isQueryStringFilter", + "description": [], "signature": [ "(filter: any) => filter is ", { @@ -25587,35 +28562,40 @@ "text": "QueryStringFilter" } ], - "description": [], - "label": "isQueryStringFilter", "source": { "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", "lineNumber": 22 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isRangeFilter", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.isRangeFilter.$1", + "parentPluginId": "data", + "id": "def-common.isQueryStringFilter.$1", "type": "Any", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { - "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 73 - } + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 22 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isRangeFilter", + "type": "Function", + "tags": [], + "label": "isRangeFilter", + "description": [], "signature": [ "(filter: any) => filter is ", { @@ -25626,35 +28606,40 @@ "text": "RangeFilter" } ], - "description": [], - "label": "isRangeFilter", "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 73 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isScriptedPhraseFilter", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.isScriptedPhraseFilter.$1", + "parentPluginId": "data", + "id": "def-common.isRangeFilter.$1", "type": "Any", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { - "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", - "lineNumber": 46 - } + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 73 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isScriptedPhraseFilter", + "type": "Function", + "tags": [], + "label": "isScriptedPhraseFilter", + "description": [], "signature": [ "(filter: any) => filter is ", { @@ -25665,35 +28650,40 @@ "text": "PhraseFilter" } ], - "description": [], - "label": "isScriptedPhraseFilter", "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 46 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isScriptedRangeFilter", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.isScriptedRangeFilter.$1", + "parentPluginId": "data", + "id": "def-common.isScriptedPhraseFilter.$1", "type": "Any", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { - "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 75 - } + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 46 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isScriptedRangeFilter", + "type": "Function", + "tags": [], + "label": "isScriptedRangeFilter", + "description": [], "signature": [ "(filter: any) => filter is ", { @@ -25704,20 +28694,40 @@ "text": "RangeFilter" } ], - "description": [], - "label": "isScriptedRangeFilter", "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 75 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.isScriptedRangeFilter.$1", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 75 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.luceneStringToDsl", "type": "Function", + "tags": [], "label": "luceneStringToDsl", + "description": [], "signature": [ "(query: any) => ", { @@ -25728,56 +28738,40 @@ "text": "DslQuery" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.luceneStringToDsl.$1", "type": "Any", + "tags": [], "label": "query", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.pinFilter", "type": "Function", - "children": [ - { - "id": "def-common.pinFilter.$1", - "type": "Object", - "label": "filter", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 97 - } - } - ], + "tags": [], + "label": "pinFilter", + "description": [], "signature": [ "(filter: ", { @@ -25796,61 +28790,129 @@ "text": "Filter" } ], - "description": [], - "label": "pinFilter", "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 97 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.pinFilter.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 97 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.shortenDottedString", "type": "Function", - "label": "shortenDottedString", - "signature": [ - "(input: any) => any" + "tags": [ + "return" ], + "label": "shortenDottedString", "description": [ "\nConvert a dot.notated.string into a short\nversion (d.n.string)\n" ], + "signature": [ + "(input: any) => any" + ], + "source": { + "path": "src/plugins/data/common/utils/shorten_dotted_string.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.shortenDottedString.$1", "type": "Any", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/utils/shorten_dotted_string.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [], - "source": { - "path": "src/plugins/data/common/utils/shorten_dotted_string.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.toElasticsearchQuery", "type": "Function", + "tags": [ + "params", + "params" + ], + "label": "toElasticsearchQuery", + "description": [], + "signature": [ + "(node: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + }, + ", indexPattern?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined, config?: Record | undefined, context?: Record | undefined) => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 66 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.toElasticsearchQuery.$1", "type": "Object", + "tags": [], "label": "node", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -25860,17 +28922,20 @@ "text": "KueryNode" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", "lineNumber": 67 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.toElasticsearchQuery.$2", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -25881,104 +28946,58 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", "lineNumber": 68 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.toElasticsearchQuery.$3", "type": "Object", + "tags": [], "label": "config", - "isRequired": false, + "description": [], "signature": [ "Record | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", "lineNumber": 69 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.toElasticsearchQuery.$4", "type": "Object", + "tags": [], "label": "context", - "isRequired": false, + "description": [], "signature": [ "Record | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", "lineNumber": 70 - } - } - ], - "signature": [ - "(node: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KueryNode", - "text": "KueryNode" - }, - ", indexPattern?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - " | undefined, config?: Record | undefined, context?: Record | undefined) => ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.JsonObject", - "text": "JsonObject" + }, + "deprecated": false, + "isRequired": false } ], - "description": [], - "label": "toElasticsearchQuery", - "source": { - "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", - "lineNumber": 66 - }, - "tags": [ - "params" - ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.toggleFilterDisabled", "type": "Function", - "children": [ - { - "id": "def-common.toggleFilterDisabled.$1", - "type": "Object", - "label": "filter", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 70 - } - } - ], + "tags": [], + "label": "toggleFilterDisabled", + "description": [], "signature": [ "(filter: ", { @@ -25998,25 +29017,19 @@ }, " | undefined; query?: any; }" ], - "description": [], - "label": "toggleFilterDisabled", "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 70 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.toggleFilterNegated", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.toggleFilterNegated.$1", + "parentPluginId": "data", + "id": "def-common.toggleFilterDisabled.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -26026,13 +29039,24 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 77 - } + "lineNumber": 70 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.toggleFilterNegated", + "type": "Function", + "tags": [], + "label": "toggleFilterNegated", + "description": [], "signature": [ "(filter: ", { @@ -26052,25 +29076,19 @@ }, " | undefined; query?: any; }" ], - "description": [], - "label": "toggleFilterNegated", "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 77 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.toggleFilterPinned", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.toggleFilterPinned.$1", + "parentPluginId": "data", + "id": "def-common.toggleFilterNegated.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -26080,13 +29098,24 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 84 - } + "lineNumber": 77 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.toggleFilterPinned", + "type": "Function", + "tags": [], + "label": "toggleFilterPinned", + "description": [], "signature": [ "(filter: ", { @@ -26114,25 +29143,19 @@ }, "; query?: any; }" ], - "description": [], - "label": "toggleFilterPinned", "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 84 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.unpinFilter", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.unpinFilter.$1", + "parentPluginId": "data", + "id": "def-common.toggleFilterPinned.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -26142,13 +29165,24 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 100 - } + "lineNumber": 84 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.unpinFilter", + "type": "Function", + "tags": [], + "label": "unpinFilter", + "description": [], "signature": [ "(filter: ", { @@ -26167,99 +29201,135 @@ "text": "Filter" } ], - "description": [], - "label": "unpinFilter", "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 100 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.unpinFilter.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 100 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "data", "id": "def-common.EsQueryConfig", "type": "Interface", + "tags": [], "label": "EsQueryConfig", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.EsQueryConfig.allowLeadingWildcards", "type": "boolean", + "tags": [], "label": "allowLeadingWildcards", "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.EsQueryConfig.queryStringOptions", "type": "Object", + "tags": [], "label": "queryStringOptions", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 19 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.EsQueryConfig.ignoreFilterIfFieldNotInIndex", "type": "boolean", + "tags": [], "label": "ignoreFilterIfFieldNotInIndex", "description": [], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.EsQueryConfig.dateFormatTZ", "type": "string", + "tags": [], "label": "dateFormatTZ", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", "lineNumber": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.EsRangeFilter", "type": "Interface", + "tags": [], "label": "EsRangeFilter", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.EsRangeFilter.range", "type": "Object", + "tags": [], "label": "range", "description": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 57 - }, "signature": [ "{ [key: string]: ", { @@ -26270,137 +29340,155 @@ "text": "RangeFilterParams" }, "; }" - ] + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 57 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 56 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FilterExistsProperty", "type": "Interface", + "tags": [], "label": "FilterExistsProperty", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FilterExistsProperty.field", "type": "Any", + "tags": [], "label": "field", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", "lineNumber": 15 - }, - "signature": [ - "any" - ] + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FilterValueFormatter", "type": "Interface", + "tags": [], "label": "FilterValueFormatter", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FilterValueFormatter.convert", "type": "Function", + "tags": [], "label": "convert", "description": [], + "signature": [ + "FilterFormatterFunction" + ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 21 }, - "signature": [ - "FilterFormatterFunction" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FilterValueFormatter.getConverterFor", "type": "Function", + "tags": [], "label": "getConverterFor", "description": [], + "signature": [ + "(type: string) => FilterFormatterFunction" + ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 22 }, - "signature": [ - "(type: string) => FilterFormatterFunction" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KbnFieldTypeOptions", "type": "Interface", + "tags": [], "label": "KbnFieldTypeOptions", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.KbnFieldTypeOptions.sortable", "type": "boolean", + "tags": [], "label": "sortable", "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", "lineNumber": 11 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KbnFieldTypeOptions.filterable", "type": "boolean", + "tags": [], "label": "filterable", "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KbnFieldTypeOptions.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KbnFieldTypeOptions.esTypes", "type": "Array", + "tags": [], "label": "esTypes", "description": [], - "source": { - "path": "src/plugins/data/common/kbn_field_types/types.ts", - "lineNumber": 14 - }, "signature": [ { "pluginId": "data", @@ -26410,175 +29498,203 @@ "text": "ES_FIELD_TYPES" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 14 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/kbn_field_types/types.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KueryNode", "type": "Interface", + "tags": [], "label": "KueryNode", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.KueryNode.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 12 }, - "signature": [ - "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.KueryNode.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 13 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/kuery/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KueryParseOptions", "type": "Interface", + "tags": [], "label": "KueryParseOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.KueryParseOptions.helpers", "type": "Object", + "tags": [], "label": "helpers", "description": [], + "signature": [ + "{ [key: string]: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 19 }, - "signature": [ - "{ [key: string]: any; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KueryParseOptions.startRule", "type": "string", + "tags": [], "label": "startRule", "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KueryParseOptions.allowLeadingWildcards", "type": "boolean", + "tags": [], "label": "allowLeadingWildcards", "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KueryParseOptions.cursorSymbol", "type": "string", + "tags": [], "label": "cursorSymbol", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 24 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KueryParseOptions.parseCursor", "type": "CompoundType", + "tags": [], "label": "parseCursor", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 25 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/kuery/types.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.LatLon", "type": "Interface", + "tags": [], "label": "LatLon", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.LatLon.lat", "type": "number", + "tags": [], "label": "lat", "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 48 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.LatLon.lon", "type": "number", + "tags": [], "label": "lon", "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 49 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", - "lineNumber": 47 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.MatchAllFilterMeta", "type": "Interface", + "tags": [], "label": "MatchAllFilterMeta", + "description": [], "signature": [ { "pluginId": "data", @@ -26596,168 +29712,194 @@ "text": "FilterMeta" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.MatchAllFilterMeta.field", "type": "Any", + "tags": [], "label": "field", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", "lineNumber": 12 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.MatchAllFilterMeta.formattedValue", "type": "string", + "tags": [], "label": "formattedValue", "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", "lineNumber": 13 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.RangeFilterParams", "type": "Interface", + "tags": [], "label": "RangeFilterParams", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeFilterParams.from", "type": "CompoundType", + "tags": [], "label": "from", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 36 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeFilterParams.to", "type": "CompoundType", + "tags": [], "label": "to", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 37 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeFilterParams.gt", "type": "CompoundType", + "tags": [], "label": "gt", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 38 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeFilterParams.lt", "type": "CompoundType", + "tags": [], "label": "lt", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 39 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeFilterParams.gte", "type": "CompoundType", + "tags": [], "label": "gte", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 40 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeFilterParams.lte", "type": "CompoundType", + "tags": [], "label": "lte", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 41 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeFilterParams.format", "type": "string", + "tags": [], "label": "format", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 42 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SavedObject", "type": "Interface", + "tags": [], "label": "SavedObject", + "description": [], "signature": [ "SavedObject", "" ], - "description": [], - "tags": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { - "tags": [], + "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`" @@ -26765,12 +29907,14 @@ "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 71 - } + }, + "deprecated": false }, { - "tags": [], + "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." @@ -26778,347 +29922,375 @@ "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 73 - } + }, + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 75 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 77 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObject.error", "type": "Object", + "tags": [], "label": "error", "description": [], + "signature": [ + "SavedObjectError", + " | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 78 }, - "signature": [ - "SavedObjectError", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObject.attributes", "type": "Uncategorized", + "tags": [], "label": "attributes", "description": [ "{@inheritdoc SavedObjectAttributes}" ], + "signature": [ + "T" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 80 }, - "signature": [ - "T" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObject.references", "type": "Array", + "tags": [], "label": "references", "description": [ "{@inheritdoc SavedObjectReference}" ], + "signature": [ + "SavedObjectReference", + "[]" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 82 }, - "signature": [ - "SavedObjectReference", - "[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObject.migrationVersion", "type": "Object", + "tags": [], "label": "migrationVersion", "description": [ "{@inheritdoc SavedObjectsMigrationVersion}" ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 84 }, - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 86 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObject.namespaces", "type": "Array", + "tags": [], "label": "namespaces", "description": [ "Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 88 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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" + ], "source": { "path": "src/core/types/saved_objects.ts", "lineNumber": 95 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 69 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "data", "id": "def-common.ES_FIELD_TYPES", "type": "Enum", + "tags": [], "label": "ES_FIELD_TYPES", - "tags": [ - "public" - ], "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", "lineNumber": 18 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FILTERS", "type": "Enum", - "label": "FILTERS", "tags": [], + "label": "FILTERS", "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/types.ts", "lineNumber": 29 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FilterStateStore", "type": "Enum", - "label": "FilterStateStore", "tags": [], + "label": "FilterStateStore", "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 9 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KBN_FIELD_TYPES", "type": "Enum", + "tags": [], "label": "KBN_FIELD_TYPES", - "tags": [ - "public" - ], "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", "lineNumber": 64 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.CSV_MIME_TYPE", "type": "string", + "tags": [], "label": "CSV_MIME_TYPE", "description": [], + "signature": [ + "\"text/plain;charset=utf-8\"" + ], "source": { "path": "src/plugins/data/common/exports/export_csv.tsx", "lineNumber": 17 }, - "signature": [ - "\"text/plain;charset=utf-8\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.CustomFilter", "type": "Type", - "label": "CustomFilter", "tags": [], + "label": "CustomFilter", "description": [], + "signature": [ + "Filter & { query: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/custom_filter.ts", "lineNumber": 11 }, - "signature": [ - "Filter & { query: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DEFAULT_QUERY_LANGUAGE", "type": "string", + "tags": [], "label": "DEFAULT_QUERY_LANGUAGE", "description": [], + "signature": [ + "\"kuery\"" + ], "source": { "path": "src/plugins/data/common/constants.ts", "lineNumber": 9 }, - "signature": [ - "\"kuery\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.DslQuery", "type": "Type", - "label": "DslQuery", "tags": [], + "label": "DslQuery", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/types.ts", "lineNumber": 16 }, - "signature": [ - "any" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExistsFilter", "type": "Type", - "label": "ExistsFilter", "tags": [], + "label": "ExistsFilter", "description": [], + "signature": [ + "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", "lineNumber": 18 }, - "signature": [ - "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExistsFilterMeta", "type": "Type", - "label": "ExistsFilterMeta", "tags": [], + "label": "ExistsFilterMeta", "description": [], + "signature": [ + "{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", "lineNumber": 12 }, - "signature": [ - "{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldFilter", "type": "Type", - "label": "FieldFilter", "tags": [], + "label": "FieldFilter", "description": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/types.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhrasesFilter", - "text": "PhrasesFilter" + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" }, " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.ExistsFilter", - "text": "ExistsFilter" + "section": "def-common.RangeFilter", + "text": "RangeFilter" }, " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhraseFilter", - "text": "PhraseFilter" + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" }, " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.RangeFilter", - "text": "RangeFilter" + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" }, " | ", { @@ -27129,340 +30301,419 @@ "text": "MatchAllFilter" } ], + "source": { + "path": "src/plugins/data/common/es_query/filters/types.ts", + "lineNumber": 19 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.Filter", "type": "Type", - "label": "Filter", "tags": [], + "label": "Filter", "description": [], + "signature": [ + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 41 }, - "signature": [ - "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FilterMeta", "type": "Type", - "label": "FilterMeta", "tags": [], + "label": "FilterMeta", "description": [], + "signature": [ + "{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 26 }, - "signature": [ - "{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FilterState", "type": "Type", - "label": "FilterState", "tags": [], + "label": "FilterState", "description": [], + "signature": [ + "{ store: FilterStateStore; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 15 }, - "signature": [ - "{ store: FilterStateStore; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.GeoBoundingBoxFilter", "type": "Type", - "label": "GeoBoundingBoxFilter", "tags": [], + "label": "GeoBoundingBoxFilter", "description": [], + "signature": [ + "Filter & { meta: GeoBoundingBoxFilterMeta; geo_bounding_box: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", "lineNumber": 18 }, - "signature": [ - "Filter & { meta: GeoBoundingBoxFilterMeta; geo_bounding_box: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.GeoBoundingBoxFilterMeta", "type": "Type", - "label": "GeoBoundingBoxFilterMeta", "tags": [], + "label": "GeoBoundingBoxFilterMeta", "description": [], + "signature": [ + "FilterMeta & { params: { bottom_right: LatLon; top_left: LatLon;}; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", "lineNumber": 11 }, - "signature": [ - "FilterMeta & { params: { bottom_right: LatLon; top_left: LatLon;}; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.GeoPolygonFilter", "type": "Type", - "label": "GeoPolygonFilter", "tags": [], + "label": "GeoPolygonFilter", "description": [], + "signature": [ + "Filter & { meta: GeoPolygonFilterMeta; geo_polygon: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", "lineNumber": 17 }, - "signature": [ - "Filter & { meta: GeoPolygonFilterMeta; geo_polygon: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.GeoPolygonFilterMeta", "type": "Type", - "label": "GeoPolygonFilterMeta", "tags": [], + "label": "GeoPolygonFilterMeta", "description": [], + "signature": [ + "FilterMeta & { params: { points: LatLon[];}; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", "lineNumber": 11 }, - "signature": [ - "FilterMeta & { params: { points: LatLon[];}; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.GetConfigFn", "type": "Type", - "label": "GetConfigFn", "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" + ], "source": { "path": "src/plugins/data/common/types.ts", "lineNumber": 23 }, - "signature": [ - "(key: string, defaultOverride: T | undefined) => T" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.KIBANA_USER_QUERY_LANGUAGE_KEY", "type": "string", + "tags": [], "label": "KIBANA_USER_QUERY_LANGUAGE_KEY", "description": [], + "signature": [ + "\"kibana.userQueryLanguage\"" + ], "source": { "path": "src/plugins/data/common/constants.ts", "lineNumber": 10 }, - "signature": [ - "\"kibana.userQueryLanguage\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.MatchAllFilter", "type": "Type", - "label": "MatchAllFilter", "tags": [], + "label": "MatchAllFilter", "description": [], + "signature": [ + "Filter & { meta: MatchAllFilterMeta; match_all: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", "lineNumber": 16 }, - "signature": [ - "Filter & { meta: MatchAllFilterMeta; match_all: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.MissingFilter", "type": "Type", - "label": "MissingFilter", "tags": [], + "label": "MissingFilter", "description": [], + "signature": [ + "Filter & { meta: MissingFilterMeta; missing: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", "lineNumber": 13 }, - "signature": [ - "Filter & { meta: MissingFilterMeta; missing: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.MissingFilterMeta", "type": "Type", - "label": "MissingFilterMeta", "tags": [], + "label": "MissingFilterMeta", "description": [], + "signature": [ + "{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", "lineNumber": 11 }, - "signature": [ - "{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.PhraseFilter", "type": "Type", - "label": "PhraseFilter", "tags": [], + "label": "PhraseFilter", "description": [], + "signature": [ + "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 21 }, - "signature": [ - "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.PhraseFilterMeta", "type": "Type", - "label": "PhraseFilterMeta", "tags": [], + "label": "PhraseFilterMeta", "description": [], + "signature": [ + "FilterMeta & { params?: { query: string; } | undefined; field?: any; index?: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", "lineNumber": 13 }, - "signature": [ - "FilterMeta & { params?: { query: string; } | undefined; field?: any; index?: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.PhrasesFilter", "type": "Type", - "label": "PhrasesFilter", "tags": [], + "label": "PhrasesFilter", "description": [], + "signature": [ + "Filter & { meta: PhrasesFilterMeta; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", "lineNumber": 19 }, - "signature": [ - "Filter & { meta: PhrasesFilterMeta; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.PhrasesFilterMeta", "type": "Type", - "label": "PhrasesFilterMeta", "tags": [], + "label": "PhrasesFilterMeta", "description": [], + "signature": [ + "FilterMeta & { params: string[]; field?: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", "lineNumber": 14 }, - "signature": [ - "FilterMeta & { params: string[]; field?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.QueryStringFilter", "type": "Type", - "label": "QueryStringFilter", "tags": [], + "label": "QueryStringFilter", "description": [], + "signature": [ + "Filter & { meta: QueryStringFilterMeta; query?: { query_string: { query: string;}; } | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", "lineNumber": 13 }, - "signature": [ - "Filter & { meta: QueryStringFilterMeta; query?: { query_string: { query: string;}; } | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.QueryStringFilterMeta", "type": "Type", - "label": "QueryStringFilterMeta", "tags": [], + "label": "QueryStringFilterMeta", "description": [], + "signature": [ + "{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", "lineNumber": 11 }, - "signature": [ - "{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.RangeFilter", "type": "Type", - "label": "RangeFilter", "tags": [], + "label": "RangeFilter", "description": [], + "signature": [ + "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 60 }, - "signature": [ - "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.RangeFilterMeta", "type": "Type", - "label": "RangeFilterMeta", "tags": [], + "label": "RangeFilterMeta", "description": [], + "signature": [ + "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 50 }, - "signature": [ - "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "data", "id": "def-common.nodeBuilder", "type": "Object", "tags": [], + "label": "nodeBuilder", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.nodeBuilder.is", "type": "Function", + "tags": [], + "label": "is", + "description": [], + "signature": [ + "(fieldName: string, value: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + }, + ") => ", + "FunctionTypeBuildNode" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.nodeBuilder.is.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.nodeBuilder.is.$2", "type": "CompoundType", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "string | ", { @@ -27473,15 +30724,25 @@ "text": "KueryNode" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.nodeBuilder.or", + "type": "Function", + "tags": [], + "label": "or", + "description": [], "signature": [ - "(fieldName: string, value: string | ", + "(nodes: ", { "pluginId": "data", "scope": "common", @@ -27489,27 +30750,28 @@ "section": "def-common.KueryNode", "text": "KueryNode" }, - ") => ", - "FunctionTypeBuildNode" + "[]) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + } ], - "description": [], - "label": "is", "source": { "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", - "lineNumber": 12 + "lineNumber": 19 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.nodeBuilder.or", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.nodeBuilder.or.$1", "type": "Array", + "tags": [], "label": "nodes", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -27520,13 +30782,23 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.nodeBuilder.and", + "type": "Function", + "tags": [], + "label": "and", + "description": [], "signature": [ "(nodes: ", { @@ -27545,24 +30817,19 @@ "text": "KueryNode" } ], - "description": [], - "label": "or", "source": { "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", - "lineNumber": 19 + "lineNumber": 22 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.nodeBuilder.and", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.nodeBuilder.and.$1", "type": "Array", + "tags": [], "label": "nodes", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -27573,138 +30840,120 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", "lineNumber": 22 - } - } - ], - "signature": [ - "(nodes: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KueryNode", - "text": "KueryNode" - }, - "[]) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KueryNode", - "text": "KueryNode" + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "and", - "source": { - "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", - "lineNumber": 22 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "nodeBuilder", - "source": { - "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.nodeTypes", "type": "Object", "tags": [], + "label": "nodeTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.nodeTypes.function", "type": "Object", + "tags": [], "label": "function", "description": [ "// This requires better typing of the different typings and their return types.\n// @ts-ignore" ], + "signature": [ + "typeof ", + "src/plugins/data/common/es_query/kuery/node_types/function" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", "lineNumber": 21 }, - "signature": [ - "typeof ", - "src/plugins/data/common/es_query/kuery/node_types/function" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.nodeTypes.literal", "type": "Object", + "tags": [], "label": "literal", "description": [], + "signature": [ + "typeof ", + "src/plugins/data/common/es_query/kuery/node_types/literal" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", "lineNumber": 22 }, - "signature": [ - "typeof ", - "src/plugins/data/common/es_query/kuery/node_types/literal" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.nodeTypes.namedArg", "type": "Object", + "tags": [], "label": "namedArg", "description": [], + "signature": [ + "typeof ", + "src/plugins/data/common/es_query/kuery/node_types/named_arg" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", "lineNumber": 23 }, - "signature": [ - "typeof ", - "src/plugins/data/common/es_query/kuery/node_types/named_arg" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.nodeTypes.wildcard", "type": "Object", + "tags": [], "label": "wildcard", "description": [], + "signature": [ + "typeof ", + "src/plugins/data/common/es_query/kuery/node_types/wildcard" + ], "source": { "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", "lineNumber": 24 }, - "signature": [ - "typeof ", - "src/plugins/data/common/es_query/kuery/node_types/wildcard" - ] + "deprecated": false } ], - "description": [], - "label": "nodeTypes", - "source": { - "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.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 COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; 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 SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }" + ], "source": { "path": "src/plugins/data/common/constants.ts", "lineNumber": 12 }, - "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 COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; 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 SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }" - ], + "deprecated": false, "initialIsOpen": false } ] diff --git a/api_docs/data_autocomplete.json b/api_docs/data_autocomplete.json index 7792a7abe5c8a..249ff7c5a7a44 100644 --- a/api_docs/data_autocomplete.json +++ b/api_docs/data_autocomplete.json @@ -5,24 +5,25 @@ "functions": [], "interfaces": [ { + "parentPluginId": "data", "id": "def-public.QuerySuggestionBasic", "type": "Interface", + "tags": [], "label": "QuerySuggestionBasic", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionBasic.type", "type": "Enum", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "lineNumber": 37 - }, "signature": [ { "pluginId": "data", @@ -31,80 +32,94 @@ "section": "def-public.QuerySuggestionTypes", "text": "QuerySuggestionTypes" } - ] + ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionBasic.description", "type": "CompoundType", + "tags": [], "label": "description", "description": [], + "signature": [ + "string | JSX.Element | undefined" + ], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 38 }, - "signature": [ - "string | JSX.Element | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionBasic.end", "type": "number", + "tags": [], "label": "end", "description": [], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 39 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionBasic.start", "type": "number", + "tags": [], "label": "start", "description": [], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 40 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionBasic.text", "type": "string", + "tags": [], "label": "text", "description": [], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 41 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionBasic.cursorIndex", "type": "number", + "tags": [], "label": "cursorIndex", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 42 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "lineNumber": 36 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.QuerySuggestionField", "type": "Interface", + "tags": [], "label": "QuerySuggestionField", + "description": [], "signature": [ { "pluginId": "data", @@ -122,21 +137,19 @@ "text": "QuerySuggestionBasic" } ], - "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionField.type", "type": "string", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "lineNumber": 47 - }, "signature": [ { "pluginId": "data", @@ -146,18 +159,20 @@ "text": "QuerySuggestionTypes" }, ".Field" - ] + ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 47 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionField.field", "type": "Object", + "tags": [], "label": "field", "description": [], - "source": { - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "lineNumber": 48 - }, "signature": [ { "pluginId": "data", @@ -166,45 +181,49 @@ "section": "def-common.IFieldType", "text": "IFieldType" } - ] + ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 48 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "lineNumber": 46 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.QuerySuggestionGetFnArgs", "type": "Interface", + "tags": [], "label": "QuerySuggestionGetFnArgs", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionGetFnArgs.language", "type": "string", + "tags": [], "label": "language", "description": [], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionGetFnArgs.indexPatterns", "type": "Array", + "tags": [], "label": "indexPatterns", "description": [], - "source": { - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "lineNumber": 26 - }, "signature": [ { "pluginId": "data", @@ -214,135 +233,145 @@ "text": "IIndexPattern" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 26 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionGetFnArgs.query", "type": "string", + "tags": [], "label": "query", "description": [], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 27 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionGetFnArgs.selectionStart", "type": "number", + "tags": [], "label": "selectionStart", "description": [], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionGetFnArgs.selectionEnd", "type": "number", + "tags": [], "label": "selectionEnd", "description": [], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 29 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionGetFnArgs.signal", "type": "Object", + "tags": [], "label": "signal", "description": [], + "signature": [ + "AbortSignal | undefined" + ], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 30 }, - "signature": [ - "AbortSignal | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionGetFnArgs.useTimeRange", "type": "CompoundType", + "tags": [], "label": "useTimeRange", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 31 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QuerySuggestionGetFnArgs.boolFilter", "type": "Any", + "tags": [], "label": "boolFilter", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 32 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "lineNumber": 24 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "data", "id": "def-public.QuerySuggestionTypes", "type": "Enum", - "label": "QuerySuggestionTypes", "tags": [], + "label": "QuerySuggestionTypes", "description": [], "source": { "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "lineNumber": 11 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "data", "id": "def-public.AutocompleteStart", "type": "Type", + "tags": [], "label": "AutocompleteStart", - "tags": [ - "public" - ], "description": [], + "signature": [ + "{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }" + ], "source": { "path": "src/plugins/data/public/autocomplete/autocomplete_service.ts", "lineNumber": 96 }, - "signature": [ - "{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.QuerySuggestion", "type": "Type", + "tags": [], "label": "QuerySuggestion", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "lineNumber": 52 - }, "signature": [ { "pluginId": "data", @@ -360,18 +389,20 @@ "text": "QuerySuggestionField" } ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 52 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.QuerySuggestionGetFn", "type": "Type", - "label": "QuerySuggestionGetFn", "tags": [], + "label": "QuerySuggestionGetFn", "description": [], - "source": { - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "lineNumber": 19 - }, "signature": [ "(args: ", { @@ -391,6 +422,11 @@ }, "[]> | undefined" ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 19 + }, + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/data_enhanced.json b/api_docs/data_enhanced.json index 6ba0ca8191d10..923a7886739c9 100644 --- a/api_docs/data_enhanced.json +++ b/api_docs/data_enhanced.json @@ -7,50 +7,56 @@ "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "dataEnhanced", "id": "def-public.ENHANCED_ES_SEARCH_STRATEGY", "type": "string", + "tags": [], "label": "ENHANCED_ES_SEARCH_STRATEGY", "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 17 - }, "signature": [ "\"ese\"" ], + "source": { + "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "dataEnhanced", "id": "def-public.EQL_SEARCH_STRATEGY", "type": "string", + "tags": [], "label": "EQL_SEARCH_STRATEGY", "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 19 - }, "signature": [ "\"eql\"" ], + "source": { + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [], "start": { + "parentPluginId": "dataEnhanced", "id": "def-public.DataEnhancedStart", "type": "Type", - "label": "DataEnhancedStart", "tags": [], + "label": "DataEnhancedStart", "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/public/plugin.ts", - "lineNumber": 38 - }, "signature": [ "void" ], + "source": { + "path": "x-pack/plugins/data_enhanced/public/plugin.ts", + "lineNumber": 37 + }, + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -58,6 +64,7 @@ "server": { "classes": [ { + "parentPluginId": "dataEnhanced", "id": "def-server.EnhancedDataServerPlugin", "type": "Class", "tags": [], @@ -85,21 +92,35 @@ "DataEnhancedStartDependencies", ">" ], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dataEnhanced", "id": "def-server.EnhancedDataServerPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dataEnhanced", "id": "def-server.EnhancedDataServerPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -108,26 +129,25 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; pageSize: number; trackingInterval: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>" + "; pageSize: number; trackingInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>" ], - "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 33 - } + "lineNumber": 26 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 33 - } + "returnComment": [] }, { + "parentPluginId": "dataEnhanced", "id": "def-server.EnhancedDataServerPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -143,13 +163,19 @@ "DataEnhancedSetupDependencies", ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dataEnhanced", "id": "def-server.EnhancedDataServerPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -162,38 +188,40 @@ "DataEnhancedStartDependencies", ", unknown>" ], - "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 38 - } + "lineNumber": 31 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dataEnhanced", "id": "def-server.EnhancedDataServerPlugin.setup.$2", "type": "Object", + "tags": [], "label": "deps", - "isRequired": true, + "description": [], "signature": [ "DataEnhancedSetupDependencies" ], - "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 38 - } + "lineNumber": 31 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 38 - } + "returnComment": [] }, { + "parentPluginId": "dataEnhanced", "id": "def-server.EnhancedDataServerPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -207,13 +235,19 @@ "DataEnhancedStartDependencies", ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { + "parentPluginId": "dataEnhanced", "id": "def-server.EnhancedDataServerPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -223,55 +257,52 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 80 - } + "lineNumber": 54 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "dataEnhanced", "id": "def-server.EnhancedDataServerPlugin.start.$2", "type": "Object", + "tags": [], "label": "{ taskManager }", - "isRequired": true, + "description": [], "signature": [ "DataEnhancedStartDependencies" ], - "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 80 - } + "lineNumber": 54 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 80 - } + "returnComment": [] }, { + "parentPluginId": "dataEnhanced", "id": "def-server.EnhancedDataServerPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 86 - } + "lineNumber": 60 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 27 - }, "initialIsOpen": false } ], @@ -280,653 +311,48 @@ "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "dataEnhanced", "id": "def-server.ENHANCED_ES_SEARCH_STRATEGY", "type": "string", + "tags": [], "label": "ENHANCED_ES_SEARCH_STRATEGY", "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 17 - }, "signature": [ "\"ese\"" ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-server.EQL_SEARCH_STRATEGY", - "type": "string", - "label": "EQL_SEARCH_STRATEGY", - "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 19 - }, - "signature": [ - "\"eql\"" - ], - "initialIsOpen": false - } - ], - "objects": [] - }, - "common": { - "classes": [], - "functions": [ - { - "id": "def-common.pollSearch", - "type": "Function", - "children": [ - { - "id": "def-common.pollSearch.$1", - "type": "Function", - "label": "search", - "isRequired": true, - "signature": [ - "() => Promise" - ], - "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts", - "lineNumber": 16 - } - }, - { - "id": "def-common.pollSearch.$2", - "type": "Function", - "label": "cancel", - "isRequired": false, - "signature": [ - "(() => void) | undefined" - ], - "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts", - "lineNumber": 17 - } - }, - { - "id": "def-common.pollSearch.$3", - "type": "Object", - "label": "{ pollInterval = 1000, abortSignal }", - "isRequired": true, - "signature": [ - { - "pluginId": "dataEnhanced", - "scope": "common", - "docId": "kibDataEnhancedPluginApi", - "section": "def-common.IAsyncSearchOptions", - "text": "IAsyncSearchOptions" - } - ], - "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts", - "lineNumber": 18 - } - } - ], - "signature": [ - ">(search: () => Promise, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ", - { - "pluginId": "dataEnhanced", - "scope": "common", - "docId": "kibDataEnhancedPluginApi", - "section": "def-common.IAsyncSearchOptions", - "text": "IAsyncSearchOptions" - }, - ") => ", - "Observable", - "" - ], - "description": [], - "label": "pollSearch", - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts", - "lineNumber": 15 - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "id": "def-common.EqlSearchStrategyRequest", - "type": "Interface", - "label": "EqlSearchStrategyRequest", - "signature": [ - { - "pluginId": "dataEnhanced", - "scope": "common", - "docId": "kibDataEnhancedPluginApi", - "section": "def-common.EqlSearchStrategyRequest", - "text": "EqlSearchStrategyRequest" - }, - " extends ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchRequest", - "text": "IKibanaSearchRequest" - }, - "<", - { - "pluginId": "dataEnhanced", - "scope": "common", - "docId": "kibDataEnhancedPluginApi", - "section": "def-common.EqlRequestParams", - "text": "EqlRequestParams" - }, - ">" - ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.EqlSearchStrategyRequest.options", - "type": "Object", - "label": "options", - "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 24 - }, - "signature": [ - "TransportRequestOptions", - " | undefined" - ] - } - ], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 23 - }, - "initialIsOpen": false - }, - { - "id": "def-common.IAsyncSearchOptions", - "type": "Interface", - "label": "IAsyncSearchOptions", - "signature": [ - { - "pluginId": "dataEnhanced", - "scope": "common", - "docId": "kibDataEnhancedPluginApi", - "section": "def-common.IAsyncSearchOptions", - "text": "IAsyncSearchOptions" - }, - " extends ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - } - ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.IAsyncSearchOptions.pollInterval", - "type": "number", - "label": "pollInterval", - "description": [ - "\nThe number of milliseconds to wait between receiving a response and sending another request" - ], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 33 - }, - "signature": [ - "number | undefined" - ] - } - ], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 29 - }, - "initialIsOpen": false - }, - { - "id": "def-common.SearchSessionRequestInfo", - "type": "Interface", - "label": "SearchSessionRequestInfo", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.SearchSessionRequestInfo.id", - "type": "string", - "label": "id", - "description": [ - "\nID of the async search request" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 80 - } - }, - { - "tags": [], - "id": "def-common.SearchSessionRequestInfo.strategy", - "type": "string", - "label": "strategy", - "description": [ - "\nSearch strategy used to submit the search request" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 84 - } - }, - { - "tags": [], - "id": "def-common.SearchSessionRequestInfo.status", - "type": "string", - "label": "status", - "description": [ - "\nstatus" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 88 - } - }, - { - "tags": [], - "id": "def-common.SearchSessionRequestInfo.error", - "type": "string", - "label": "error", - "description": [ - "\nAn optional error. Set if status is set to error." - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 92 - }, - "signature": [ - "string | undefined" - ] - } - ], "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 76 + "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", + "lineNumber": 11 }, + "deprecated": false, "initialIsOpen": false }, { - "id": "def-common.SearchSessionSavedObjectAttributes", - "type": "Interface", - "label": "SearchSessionSavedObjectAttributes", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.sessionId", - "type": "string", - "label": "sessionId", - "description": [], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 13 - } - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.name", - "type": "string", - "label": "name", - "description": [ - "\nUser-facing session name to be displayed in session management" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 17 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.appId", - "type": "string", - "label": "appId", - "description": [ - "\nApp that created the session. e.g 'discover'" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 21 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.created", - "type": "string", - "label": "created", - "description": [ - "\nCreation time of the session" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 25 - } - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.touched", - "type": "string", - "label": "touched", - "description": [ - "\nLast touch time of the session" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 29 - } - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.expires", - "type": "string", - "label": "expires", - "description": [ - "\nExpiration time of the session. Expiration itself is managed by Elasticsearch." - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 33 - } - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.completed", - "type": "CompoundType", - "label": "completed", - "description": [ - "\nTime of transition into completed state,\n\nCan be \"null\" in case already completed session\ntransitioned into in-progress session" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 40 - }, - "signature": [ - "string | null | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.status", - "type": "Enum", - "label": "status", - "description": [ - "\nstatus" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 44 - }, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSessionStatus", - "text": "SearchSessionStatus" - } - ] - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.urlGeneratorId", - "type": "string", - "label": "urlGeneratorId", - "description": [ - "\nurlGeneratorId" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 48 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.initialState", - "type": "Object", - "label": "initialState", - "description": [ - "\nThe application state that was used to create the session.\nShould be used, for example, to re-load an expired search session." - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 53 - }, - "signature": [ - "Record | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.restoreState", - "type": "Object", - "label": "restoreState", - "description": [ - "\nApplication state that should be used to restore the session.\nFor example, relative dates are conveted to absolute ones." - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 58 - }, - "signature": [ - "Record | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.idMapping", - "type": "Object", - "label": "idMapping", - "description": [ - "\nMapping of search request hashes to their corresponsing info (async search id, etc.)" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 62 - }, - "signature": [ - "Record" - ] - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.persisted", - "type": "boolean", - "label": "persisted", - "description": [ - "\nThis value is true if the session was actively stored by the user. If it is false, the session may be purged by the system." - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 67 - } - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.realmType", - "type": "string", - "label": "realmType", - "description": [ - "\nThe realm type/name & username uniquely identifies the user who created this search session" - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 71 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.realmName", - "type": "string", - "label": "realmName", - "description": [], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 72 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSessionSavedObjectAttributes.username", - "type": "string", - "label": "username", - "description": [], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 73 - }, - "signature": [ - "string | undefined" - ] - } - ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 12 - }, - "initialIsOpen": false - } - ], - "enums": [ - { - "id": "def-common.SearchSessionStatus", - "type": "Enum", - "label": "SearchSessionStatus", - "tags": [], - "description": [], - "source": { - "path": "src/plugins/data/common/search/session/status.ts", - "lineNumber": 9 - }, - "initialIsOpen": false - } - ], - "misc": [ - { - "tags": [], - "id": "def-common.ENHANCED_ES_SEARCH_STRATEGY", + "parentPluginId": "dataEnhanced", + "id": "def-server.EQL_SEARCH_STRATEGY", "type": "string", - "label": "ENHANCED_ES_SEARCH_STRATEGY", - "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 17 - }, - "signature": [ - "\"ese\"" - ], - "initialIsOpen": false - }, - { "tags": [], - "id": "def-common.EQL_SEARCH_STRATEGY", - "type": "string", "label": "EQL_SEARCH_STRATEGY", "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 19 - }, "signature": [ "\"eql\"" ], - "initialIsOpen": false - }, - { - "id": "def-common.EqlRequestParams", - "type": "Type", - "label": "EqlRequestParams", - "tags": [], - "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 21 - }, - "signature": [ - "EqlSearch>" - ], - "initialIsOpen": false - }, - { - "id": "def-common.EqlSearchStrategyResponse", - "type": "Type", - "label": "EqlSearchStrategyResponse", - "tags": [], - "description": [], - "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 27 - }, - "signature": [ - "IKibanaSearchResponse>" - ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-common.SEARCH_SESSION_TYPE", - "type": "string", - "label": "SEARCH_SESSION_TYPE", - "description": [], "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 11 + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 14 }, - "signature": [ - "\"search-session\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] } } \ No newline at end of file diff --git a/api_docs/data_enhanced.mdx b/api_docs/data_enhanced.mdx index fc3b5ad770277..07a00b908e7b2 100644 --- a/api_docs/data_enhanced.mdx +++ b/api_docs/data_enhanced.mdx @@ -27,17 +27,3 @@ import dataEnhancedObj from './data_enhanced.json'; ### Consts, variables and types -## Common - -### Functions - - -### Interfaces - - -### Enums - - -### Consts, variables and types - - diff --git a/api_docs/data_field_formats.json b/api_docs/data_field_formats.json index 052c8144f3574..9f4e7b8fe2461 100644 --- a/api_docs/data_field_formats.json +++ b/api_docs/data_field_formats.json @@ -7,15 +7,12 @@ "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.baseFormattersPublic", "type": "Array", + "tags": [], "label": "baseFormattersPublic", "description": [], - "source": { - "path": "src/plugins/data/public/field_formats/constants.ts", - "lineNumber": 12 - }, "signature": [ "(typeof ", "DateFormat", @@ -25,23 +22,28 @@ "FieldFormatInstanceType", ")[]" ], + "source": { + "path": "src/plugins/data/public/field_formats/constants.ts", + "lineNumber": 12 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.FieldFormatsStart", "type": "Type", + "tags": [], "label": "FieldFormatsStart", - "tags": [ - "public" - ], "description": [], + "signature": [ + "Pick & { deserialize: FormatFactory; }" + ], "source": { "path": "src/plugins/data/public/field_formats/field_formats_service.ts", "lineNumber": 55 }, - "signature": [ - "Pick & { deserialize: FormatFactory; }" - ], + "deprecated": false, "initialIsOpen": false } ], @@ -58,6 +60,7 @@ "common": { "classes": [ { + "parentPluginId": "data", "id": "def-common.BoolFormat", "type": "Class", "tags": [], @@ -80,17 +83,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.BoolFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/boolean.ts", - "lineNumber": 16 - }, "signature": [ { "pluginId": "data", @@ -99,29 +104,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 16 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BoolFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/boolean.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BoolFormat.fieldType", "type": "Array", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/boolean.ts", - "lineNumber": 20 - }, "signature": [ { "pluginId": "data", @@ -131,47 +140,54 @@ "text": "KBN_FIELD_TYPES" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 20 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.BoolFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(value: any) => string" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.BoolFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/boolean.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any) => string" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/boolean.ts", - "lineNumber": 22 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/boolean.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.BytesFormat", "type": "Class", "tags": [], @@ -188,17 +204,19 @@ " extends ", "NumeralFormat" ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.BytesFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/bytes.ts", - "lineNumber": 14 - }, "signature": [ { "pluginId": "data", @@ -207,29 +225,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 14 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BytesFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/bytes.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BytesFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/bytes.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "data", @@ -238,38 +260,44 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BytesFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/bytes.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BytesFormat.allowsNumericalAggregations", "type": "boolean", + "tags": [], "label": "allowsNumericalAggregations", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/bytes.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/bytes.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ColorFormat", "type": "Class", "tags": [], @@ -292,17 +320,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.tsx", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.ColorFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/color.tsx", - "lineNumber": 20 - }, "signature": [ { "pluginId": "data", @@ -311,29 +341,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.tsx", + "lineNumber": 20 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ColorFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/color.tsx", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ColorFormat.fieldType", "type": "Array", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/color.tsx", - "lineNumber": 24 - }, "signature": [ { "pluginId": "data", @@ -343,94 +377,108 @@ "text": "KBN_FIELD_TYPES" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.tsx", + "lineNumber": 24 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.ColorFormat.getParamDefaults", "type": "Function", + "tags": [], "label": "getParamDefaults", + "description": [], "signature": [ "() => { fieldType: null; colors: { range: string; regex: string; text: string; background: string; }[]; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/converters/color.tsx", "lineNumber": 26 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.ColorFormat.findColorRuleForVal", "type": "Function", + "tags": [], "label": "findColorRuleForVal", + "description": [], "signature": [ "(val: any) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.tsx", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.ColorFormat.findColorRuleForVal.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/color.tsx", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/color.tsx", - "lineNumber": 33 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.ColorFormat.htmlConvert", "type": "Function", + "tags": [], + "label": "htmlConvert", + "description": [], + "signature": [ + "(val: any) => string" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.tsx", + "lineNumber": 52 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.ColorFormat.htmlConvert.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/color.tsx", "lineNumber": 52 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(val: any) => string" - ], - "description": [], - "label": "htmlConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/color.tsx", - "lineNumber": 52 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/color.tsx", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.DurationFormat", "type": "Class", "tags": [], @@ -453,17 +501,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 157 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.DurationFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 158 - }, "signature": [ { "pluginId": "data", @@ -472,29 +522,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 158 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DurationFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", "lineNumber": 159 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DurationFormat.fieldType", "type": "Enum", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 162 - }, "signature": [ { "pluginId": "data", @@ -503,280 +557,315 @@ "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 162 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DurationFormat.inputFormats", "type": "Array", + "tags": [], "label": "inputFormats", "description": [], + "signature": [ + "{ text: string; kind: string; }[]" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", "lineNumber": 163 }, - "signature": [ - "{ text: string; kind: string; }[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DurationFormat.outputFormats", "type": "Array", + "tags": [], "label": "outputFormats", "description": [], + "signature": [ + "{ text: string; method: string; }[]" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", "lineNumber": 164 }, - "signature": [ - "{ text: string; method: string; }[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DurationFormat.allowsNumericalAggregations", "type": "boolean", + "tags": [], "label": "allowsNumericalAggregations", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", "lineNumber": 165 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.DurationFormat.isHuman", "type": "Function", + "tags": [], "label": "isHuman", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", "lineNumber": 167 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.DurationFormat.getParamDefaults", "type": "Function", + "tags": [], "label": "getParamDefaults", + "description": [], "signature": [ "() => { inputFormat: string; outputFormat: string; outputPrecision: number; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", "lineNumber": 170 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.DurationFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(val: any) => string" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 178 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.DurationFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", "lineNumber": 178 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(val: any) => string" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 178 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 157 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormat", "type": "Class", "tags": [], "label": "FieldFormat", "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", + "id": "def-common.FieldFormat.id", + "type": "string", "tags": [ "property", - "static", - "public" + "static" ], - "id": "def-common.FieldFormat.id", - "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.FieldFormat.title", + "type": "string", "tags": [ "property", - "static", - "public" + "static" ], - "id": "def-common.FieldFormat.title", - "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 38 - } + }, + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.FieldFormat.fieldType", + "type": "CompoundType", "tags": [ "property", "private" ], - "id": "def-common.FieldFormat.fieldType", - "type": "CompoundType", "label": "fieldType", "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 44 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.FieldFormat.convertObject", + "type": "Object", "tags": [ "property", "private" ], - "id": "def-common.FieldFormat.convertObject", - "type": "Object", "label": "convertObject", "description": [], + "signature": [ + "FieldFormatConvert", + " | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 52 }, - "signature": [ - "FieldFormatConvert", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.FieldFormat.htmlConvert", + "type": "Function", "tags": [ "property", "protected" ], - "id": "def-common.FieldFormat.htmlConvert", - "type": "Function", "label": "htmlConvert", "description": [], + "signature": [ + "HtmlContextTypeConvert", + " | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 60 }, - "signature": [ - "HtmlContextTypeConvert", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.FieldFormat.textConvert", + "type": "Function", "tags": [ "property", "protected" ], - "id": "def-common.FieldFormat.textConvert", - "type": "Function", "label": "textConvert", "description": [], + "signature": [ + "TextContextTypeConvert", + " | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 68 }, - "signature": [ - "TextContextTypeConvert", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.FieldFormat.type", + "type": "Any", "tags": [ "property", "private" ], - "id": "def-common.FieldFormat.type", - "type": "Any", "label": "type", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 74 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldFormat.allowsNumericalAggregations", "type": "CompoundType", + "tags": [], "label": "allowsNumericalAggregations", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 75 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldFormat._params", "type": "Any", + "tags": [], "label": "_params", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 77 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldFormat.getConfig", "type": "Function", + "tags": [], "label": "getConfig", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 78 - }, "signature": [ { "pluginId": "data", @@ -786,36 +875,53 @@ "text": "GetConfigFn" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 78 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormat.Unnamed.$1", "type": "Object", + "tags": [], "label": "_params", - "isRequired": true, + "description": [], "signature": [ "IFieldFormatMetaParams" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 80 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.Unnamed.$2", "type": "Function", + "tags": [], "label": "getConfig", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -826,24 +932,27 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 80 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 80 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.convert", "type": "Function", + "tags": [ + "return" + ], "label": "convert", + "description": [ + "\nConvert a raw value to a formatted string" + ], "signature": [ "(value: any, contentType?: ", { @@ -857,29 +966,38 @@ "HtmlContextTypeOptions", " | undefined) => string" ], - "description": [ - "\nConvert a raw value to a formatted string" - ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormat.convert.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 99 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.convert.$2", "type": "CompoundType", + "tags": [], "label": "contentType", - "isRequired": true, + "description": [ + "- optional content type, the only two contentTypes\ncurrently supported are \"html\" and \"text\", which helps\nformatters adjust to different contexts" + ], "signature": [ { "pluginId": "data", @@ -889,47 +1007,48 @@ "text": "FieldFormatsContentType" } ], - "description": [ - "- optional content type, the only two contentTypes\ncurrently supported are \"html\" and \"text\", which helps\nformatters adjust to different contexts" - ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 100 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.convert.$3", "type": "CompoundType", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ "Record | ", "HtmlContextTypeOptions", " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 101 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return", - "public" - ], "returnComment": [ "- the formatted string, which is assumed to be html, safe for\n injecting into the DOM or a DOM attribute" - ], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 98 - } + ] }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.getConverterFor", "type": "Function", + "tags": [ + "return" + ], "label": "getConverterFor", + "description": [ + "\nGet a convert function that is bound to a specific contentType" + ], "signature": [ "(contentType?: ", { @@ -942,15 +1061,19 @@ ") => ", "FieldFormatConvertFunction" ], - "description": [ - "\nGet a convert function that is bound to a specific contentType" - ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 118 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormat.getConverterFor.$1", "type": "CompoundType", + "tags": [], "label": "contentType", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -960,132 +1083,135 @@ "text": "FieldFormatsContentType" } ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 119 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return", - "public" - ], "returnComment": [ "- a bound converter function" - ], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 118 - } + ] }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.getParamDefaults", "type": "Function", - "label": "getParamDefaults", - "signature": [ - "() => Record" + "tags": [ + "return" ], + "label": "getParamDefaults", "description": [ "\nGet parameter defaults" ], - "children": [], - "tags": [ - "return", - "public" - ], - "returnComment": [ - "- parameter defaults" + "signature": [ + "() => Record" ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 133 - } + }, + "deprecated": false, + "children": [], + "returnComment": [ + "- parameter defaults" + ] }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.param", "type": "Function", - "label": "param", - "signature": [ - "(name: string) => any" + "tags": [ + "return" ], + "label": "param", "description": [ "\nGet the value of a param. This value may be a default value.\n" ], + "signature": [ + "(name: string) => any" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 144 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormat.param.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- the param name to fetch" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 144 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return", - "public" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 144 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.params", "type": "Function", - "label": "params", - "signature": [ - "() => Record" + "tags": [ + "return" ], + "label": "params", "description": [ "\nGet all of the params in a single object" ], - "children": [], - "tags": [ - "return", - "public" + "signature": [ + "() => Record" ], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 161 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.toJSON", "type": "Function", - "label": "toJSON", - "signature": [ - "() => { id: any; params: any; }" + "tags": [ + "return" ], + "label": "toJSON", "description": [ "\nSerialize this format to a simple POJO, with only the params\nthat are not default\n" ], - "children": [], - "tags": [ - "return", - "public" + "signature": [ + "() => { id: any; params: any; }" ], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 172 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.from", "type": "Function", + "tags": [], "label": "from", + "description": [], "signature": [ "typeof ", { @@ -1097,51 +1223,58 @@ }, ".from" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 193 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormat.from.$1", "type": "Function", + "tags": [], "label": "convertFn", - "isRequired": true, + "description": [], "signature": [ "FieldFormatConvertFunction" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 193 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 193 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.setupContentType", "type": "Function", + "tags": [], "label": "setupContentType", + "description": [], "signature": [ "() => ", "FieldFormatConvert" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 197 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormat.isInstanceOfFieldFormat", "type": "Function", + "tags": [], "label": "isInstanceOfFieldFormat", + "description": [], "signature": [ "typeof ", { @@ -1153,38 +1286,37 @@ }, ".isInstanceOfFieldFormat" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 204 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormat.isInstanceOfFieldFormat.$1", "type": "Any", + "tags": [], "label": "fieldFormat", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", "lineNumber": 204 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 204 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/field_format.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatNotFoundError", "type": "Class", "tags": [], @@ -1200,127 +1332,147 @@ }, " extends Error" ], + "source": { + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldFormatNotFoundError.formatId", "type": "string", + "tags": [], "label": "formatId", "description": [], "source": { "path": "src/plugins/data/common/field_formats/errors.ts", "lineNumber": 10 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatNotFoundError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatNotFoundError.Unnamed.$1", "type": "string", + "tags": [], "label": "message", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/errors.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormatNotFoundError.Unnamed.$2", "type": "string", + "tags": [], "label": "formatId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/errors.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/errors.ts", - "lineNumber": 11 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/errors.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry", "type": "Class", "tags": [], "label": "FieldFormatsRegistry", "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.fieldFormats", "type": "Object", + "tags": [], "label": "fieldFormats", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 29 - }, "signature": [ "Map" - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 29 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.defaultMap", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "defaultMap", + "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "children": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.metaParamsOptions", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "metaParamsOptions", + "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "children": [] }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getConfig", "type": "Function", + "tags": [], "label": "getConfig", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 32 - }, "signature": [ { "pluginId": "data", @@ -1330,34 +1482,20 @@ "text": "GetConfigFn" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 32 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.deserialize", "type": "Function", - "children": [ - { - "id": "def-common.FieldFormatsRegistry.deserialize.$1", - "type": "Object", - "label": "mapping", - "isRequired": false, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "> | undefined" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 34 - } - } - ], + "tags": [], + "label": "deserialize", + "description": [], "signature": [ "(mapping?: ", { @@ -1376,19 +1514,46 @@ "text": "FieldFormat" } ], - "description": [], - "label": "deserialize", "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 34 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.FieldFormatsRegistry.deserialize.$1", + "type": "Object", + "tags": [], + "label": "mapping", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "> | undefined" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 34 + }, + "deprecated": false, + "isRequired": false + } + ], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.init", "type": "Function", + "tags": [], "label": "init", + "description": [], "signature": [ "(getConfig: ", { @@ -1402,13 +1567,19 @@ "FieldFormatInstanceType", "[]) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.init.$1", "type": "Function", + "tags": [], "label": "getConfig", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1418,58 +1589,101 @@ "text": "GetConfigFn" } ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 52 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.init.$2", "type": "Object", + "tags": [], "label": "metaParamsOptions", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.init.$3", "type": "Array", + "tags": [], "label": "defaultFieldConverters", - "isRequired": true, + "description": [], "signature": [ "FieldFormatInstanceType", "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 51 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultConfig", "type": "Function", + "tags": [ + "return" + ], + "label": "getDefaultConfig", + "description": [ + "\nGet the id of the default type for this field type\nusing the format:defaultTypeMap config map\n" + ], + "signature": [ + "(fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConfig", + "text": "FieldFormatConfig" + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultConfig.$1", "type": "Enum", + "tags": [], "label": "fieldType", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1479,17 +1693,20 @@ "text": "KBN_FIELD_TYPES" } ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 72 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultConfig.$2", "type": "Array", + "tags": [], "label": "esTypes", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -1500,131 +1717,141 @@ }, "[] | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 73 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(fieldType: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" - }, - ", esTypes?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" - }, - "[] | undefined) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConfig", - "text": "FieldFormatConfig" - } + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.FieldFormatsRegistry.getType", + "type": "Function", + "tags": [ + "return" ], + "label": "getType", "description": [ - "\nGet the id of the default type for this field type\nusing the format:defaultTypeMap config map\n" + "\nGet a derived FieldFormat class by its id.\n" + ], + "signature": [ + "(formatId: string) => ", + "FieldFormatInstanceType", + " | undefined" ], - "label": "getDefaultConfig", "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 71 + "lineNumber": 88 }, - "tags": [ - "return" - ], - "returnComment": [] - }, - { - "id": "def-common.FieldFormatsRegistry.getType", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getType.$1", "type": "string", + "tags": [], "label": "formatId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 88 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.FieldFormatsRegistry.getTypeWithoutMetaParams", + "type": "Function", + "tags": [], + "label": "getTypeWithoutMetaParams", + "description": [], "signature": [ "(formatId: string) => ", "FieldFormatInstanceType", " | undefined" ], - "description": [ - "\nGet a derived FieldFormat class by its id.\n" - ], - "label": "getType", "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 88 + "lineNumber": 102 }, - "tags": [ - "return" - ], - "returnComment": [] - }, - { - "id": "def-common.FieldFormatsRegistry.getTypeWithoutMetaParams", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getTypeWithoutMetaParams.$1", "type": "string", + "tags": [], "label": "formatId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 102 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.FieldFormatsRegistry.getDefaultType", + "type": "Function", + "tags": [ + "return" + ], + "label": "getDefaultType", + "description": [ + "\nGet the default FieldFormat type (class) for\na field type, using the format:defaultTypeMap.\nused by the field editor\n" + ], "signature": [ - "(formatId: string) => ", + "(fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", "FieldFormatInstanceType", " | undefined" ], - "description": [], - "label": "getTypeWithoutMetaParams", "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 102 + "lineNumber": 115 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.FieldFormatsRegistry.getDefaultType", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultType.$1", "type": "Enum", + "tags": [], "label": "fieldType", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1634,17 +1861,20 @@ "text": "KBN_FIELD_TYPES" } ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 116 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultType.$2", "type": "Array", + "tags": [], "label": "esTypes", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -1655,23 +1885,37 @@ }, "[] | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 117 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.FieldFormatsRegistry.getTypeNameByEsTypes", + "type": "Function", + "tags": [ + "return" + ], + "label": "getTypeNameByEsTypes", + "description": [ + "\nGet the name of the default type for ES types like date_nanos\nusing the format:defaultTypeMap config map\n" + ], "signature": [ - "(fieldType: ", + "(esTypes: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" }, - ", esTypes?: ", + "[] | undefined) => ", { "pluginId": "data", "scope": "common", @@ -1679,32 +1923,21 @@ "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" }, - "[] | undefined) => ", - "FieldFormatInstanceType", " | undefined" ], - "description": [ - "\nGet the default FieldFormat type (class) for\na field type, using the format:defaultTypeMap.\nused by the field editor\n" - ], - "label": "getDefaultType", "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 115 + "lineNumber": 131 }, - "tags": [ - "return" - ], - "returnComment": [] - }, - { - "id": "def-common.FieldFormatsRegistry.getTypeNameByEsTypes", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getTypeNameByEsTypes.$1", "type": "Array", + "tags": [], "label": "esTypes", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -1715,15 +1948,37 @@ }, "[] | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 131 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.FieldFormatsRegistry.getDefaultTypeName", + "type": "Function", + "tags": [ + "return" + ], + "label": "getDefaultTypeName", + "description": [ + "\nGet the default FieldFormat type name for\na field type, using the format:defaultTypeMap.\n" + ], "signature": [ - "(esTypes: ", + "(fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", { "pluginId": "data", "scope": "common", @@ -1732,37 +1987,35 @@ "text": "ES_FIELD_TYPES" }, "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" - }, - " | undefined" - ], - "description": [ - "\nGet the name of the default type for ES types like date_nanos\nusing the format:defaultTypeMap config map\n" + } ], - "label": "getTypeNameByEsTypes", "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 131 + "lineNumber": 147 }, - "tags": [ - "return" - ], - "returnComment": [] - }, - { - "id": "def-common.FieldFormatsRegistry.getDefaultTypeName", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultTypeName.$1", "type": "Enum", + "tags": [], "label": "fieldType", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1772,17 +2025,20 @@ "text": "KBN_FIELD_TYPES" } ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 148 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultTypeName.$2", "type": "Array", + "tags": [], "label": "esTypes", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -1793,95 +2049,94 @@ }, "[] | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 149 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.FieldFormatsRegistry.getInstance", + "type": "Function", + "tags": [ + "return" + ], + "label": "getInstance", + "description": [ + "\nGet the singleton instance of the FieldFormat type by its id.\n" + ], "signature": [ - "(fieldType: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" - }, - ", esTypes?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" - }, - "[] | undefined) => ", + "((formatId: string, params?: Record) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" }, - " | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" - } - ], - "description": [ - "\nGet the default FieldFormat type name for\na field type, using the format:defaultTypeMap.\n" + ") & _.MemoizedFunction" ], - "label": "getDefaultTypeName", "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 147 + "lineNumber": 162 }, - "tags": [ - "return" - ], - "returnComment": [] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain", + "type": "Function", "tags": [ "return" ], - "id": "def-common.FieldFormatsRegistry.getInstance", - "type": "Function", - "label": "getInstance", + "label": "getDefaultInstancePlain", "description": [ - "\nGet the singleton instance of the FieldFormat type by its id.\n" + "\nGet the default fieldFormat instance for a field format.\n" ], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 162 - }, "signature": [ - "((formatId: string, params?: Record) => ", + "(fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined, params?: Record) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", "section": "def-common.FieldFormat", "text": "FieldFormat" - }, - ") & _.MemoizedFunction" - ] - }, - { - "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain", - "type": "Function", + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 186 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain.$1", "type": "Enum", + "tags": [], "label": "fieldType", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1891,17 +2146,20 @@ "text": "KBN_FIELD_TYPES" } ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 187 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain.$2", "type": "Array", + "tags": [], "label": "esTypes", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -1912,70 +2170,44 @@ }, "[] | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 188 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 189 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(fieldType: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" - }, - ", esTypes?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" - }, - "[] | undefined, params?: Record) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } - ], - "description": [ - "\nGet the default fieldFormat instance for a field format.\n" - ], - "label": "getDefaultInstancePlain", - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 186 - }, - "tags": [ - "return" - ], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver", "type": "Function", + "tags": [ + "return" + ], "label": "getDefaultInstanceCacheResolver", + "description": [ + "\nReturns a cache key built by the given variables for caching in memoized\nWhere esType contains fieldType, fieldType is returned\n-> kibana types have a higher priority in that case\n-> would lead to failing tests that match e.g. date format with/without esTypes\nhttps://lodash.com/docs#memoize\n" + ], "signature": [ "(fieldType: ", { @@ -1995,15 +2227,19 @@ }, "[]) => string" ], - "description": [ - "\nReturns a cache key built by the given variables for caching in memoized\nWhere esType contains fieldType, fieldType is returned\n-> kibana types have a higher priority in that case\n-> would lead to failing tests that match e.g. date format with/without esTypes\nhttps://lodash.com/docs#memoize\n" - ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 210 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver.$1", "type": "Enum", + "tags": [], "label": "fieldType", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -2013,17 +2249,20 @@ "text": "KBN_FIELD_TYPES" } ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 210 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver.$2", "type": "Array", + "tags": [], "label": "esTypes", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -2034,26 +2273,27 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 210 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 210 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getByFieldType", "type": "Function", + "tags": [ + "return" + ], "label": "getByFieldType", + "description": [ + "\nGet filtered list of field formats by format type\n" + ], "signature": [ "(fieldType: ", { @@ -2067,15 +2307,19 @@ "FieldFormatInstanceType", "[]" ], - "description": [ - "\nGet filtered list of field formats by format type\n" - ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 223 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.getByFieldType.$1", "type": "Enum", + "tags": [], "label": "fieldType", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -2085,36 +2329,27 @@ "text": "KBN_FIELD_TYPES" } ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 223 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 223 - } + "returnComment": [] }, { + "parentPluginId": "data", + "id": "def-common.FieldFormatsRegistry.getDefaultInstance", + "type": "Function", "tags": [ "return" ], - "id": "def-common.FieldFormatsRegistry.getDefaultInstance", - "type": "Function", "label": "getDefaultInstance", "description": [ "\nGet the default fieldFormat instance for a field format.\nIt's a memoized function that builds and reads a cache\n" ], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 242 - }, "signature": [ "((fieldType: ", { @@ -2141,81 +2376,93 @@ "text": "FieldFormat" }, ") & _.MemoizedFunction" - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 242 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.parseDefaultTypeMap", "type": "Function", + "tags": [], "label": "parseDefaultTypeMap", + "description": [], "signature": [ "(value: any) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 244 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.parseDefaultTypeMap.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 244 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(fieldFormats: ", "FieldFormatInstanceType", "[]) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 255 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatsRegistry.register.$1", "type": "Array", + "tags": [], "label": "fieldFormats", - "isRequired": true, + "description": [], "signature": [ "FieldFormatInstanceType", "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 255 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 255 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.HistogramFormat", "type": "Class", "tags": [], @@ -2238,17 +2485,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.HistogramFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "data", @@ -2257,18 +2506,20 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.HistogramFormat.fieldType", "type": "Enum", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "data", @@ -2277,29 +2528,33 @@ "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.HistogramFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/histogram.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.HistogramFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 24 - }, "signature": [ { "pluginId": "data", @@ -2308,85 +2563,98 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 24 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.HistogramFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/histogram.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.HistogramFormat.allowsNumericalAggregations", "type": "boolean", + "tags": [], "label": "allowsNumericalAggregations", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/histogram.ts", "lineNumber": 26 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.HistogramFormat.getParamDefaults", "type": "Function", + "tags": [], "label": "getParamDefaults", + "description": [], "signature": [ "() => { id: string; params: {}; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/converters/histogram.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.HistogramFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(val: any) => string" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.HistogramFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/histogram.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(val: any) => string" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 36 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IpFormat", "type": "Class", "tags": [], @@ -2409,17 +2677,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/ip.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IpFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/ip.ts", - "lineNumber": 15 - }, "signature": [ { "pluginId": "data", @@ -2428,29 +2698,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/ip.ts", + "lineNumber": 15 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IpFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/ip.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IpFormat.fieldType", "type": "Enum", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/ip.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "data", @@ -2459,47 +2733,54 @@ "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/ip.ts", + "lineNumber": 19 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IpFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(val: any) => any" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/ip.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IpFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/ip.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(val: any) => any" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/ip.ts", - "lineNumber": 21 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/ip.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.NumberFormat", "type": "Class", "tags": [], @@ -2516,17 +2797,19 @@ " extends ", "NumeralFormat" ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/number.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.NumberFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/number.ts", - "lineNumber": 14 - }, "signature": [ { "pluginId": "data", @@ -2535,29 +2818,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/number.ts", + "lineNumber": 14 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.NumberFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/number.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.NumberFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/number.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "data", @@ -2566,38 +2853,44 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/number.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.NumberFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/number.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.NumberFormat.allowsNumericalAggregations", "type": "boolean", + "tags": [], "label": "allowsNumericalAggregations", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/number.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/number.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.PercentFormat", "type": "Class", "tags": [], @@ -2614,17 +2907,19 @@ " extends ", "NumeralFormat" ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.PercentFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/percent.ts", - "lineNumber": 15 - }, "signature": [ { "pluginId": "data", @@ -2633,29 +2928,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 15 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.PercentFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/percent.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.PercentFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/percent.ts", - "lineNumber": 20 - }, "signature": [ { "pluginId": "data", @@ -2664,85 +2963,98 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 20 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.PercentFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/percent.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.PercentFormat.allowsNumericalAggregations", "type": "boolean", + "tags": [], "label": "allowsNumericalAggregations", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/percent.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.PercentFormat.getParamDefaults", "type": "Function", - "children": [], + "tags": [], + "label": "getParamDefaults", + "description": [], "signature": [ "() => { pattern: any; fractional: boolean; }" ], - "description": [], - "label": "getParamDefaults", "source": { "path": "src/plugins/data/common/field_formats/converters/percent.ts", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.PercentFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(val: any) => string" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.PercentFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/percent.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(val: any) => string" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/percent.ts", - "lineNumber": 29 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/percent.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.RelativeDateFormat", "type": "Class", "tags": [], @@ -2765,17 +3077,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.RelativeDateFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", - "lineNumber": 16 - }, "signature": [ { "pluginId": "data", @@ -2784,29 +3098,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", + "lineNumber": 16 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RelativeDateFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RelativeDateFormat.fieldType", "type": "Enum", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", - "lineNumber": 20 - }, "signature": [ { "pluginId": "data", @@ -2815,47 +3133,54 @@ "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", + "lineNumber": 20 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.RelativeDateFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(val: any) => any" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.RelativeDateFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(val: any) => any" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", - "lineNumber": 22 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SourceFormat", "type": "Class", "tags": [], @@ -2878,17 +3203,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SourceFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/source.tsx", - "lineNumber": 39 - }, "signature": [ { "pluginId": "data", @@ -2897,29 +3224,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 39 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SourceFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/source.tsx", "lineNumber": 40 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SourceFormat.fieldType", "type": "Enum", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/source.tsx", - "lineNumber": 41 - }, "signature": [ { "pluginId": "data", @@ -2928,95 +3259,110 @@ "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 41 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.SourceFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(value: any) => string" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SourceFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/source.tsx", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any) => string" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/source.tsx", - "lineNumber": 43 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SourceFormat.htmlConvert", "type": "Function", + "tags": [], + "label": "htmlConvert", + "description": [], + "signature": [ + "(value: any, options?: ", + "HtmlContextTypeOptions", + " | undefined) => string" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SourceFormat.htmlConvert.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/source.tsx", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.SourceFormat.htmlConvert.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ "HtmlContextTypeOptions", " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/source.tsx", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(value: any, options?: ", - "HtmlContextTypeOptions", - " | undefined) => string" - ], - "description": [], - "label": "htmlConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/source.tsx", - "lineNumber": 45 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/source.tsx", - "lineNumber": 38 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.StaticLookupFormat", "type": "Class", "tags": [], @@ -3039,17 +3385,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.StaticLookupFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", - "lineNumber": 25 - }, "signature": [ { "pluginId": "data", @@ -3058,29 +3406,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 25 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.StaticLookupFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", "lineNumber": 26 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.StaticLookupFormat.fieldType", "type": "Array", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", - "lineNumber": 29 - }, "signature": [ { "pluginId": "data", @@ -3090,63 +3442,72 @@ "text": "KBN_FIELD_TYPES" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 29 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.StaticLookupFormat.getParamDefaults", "type": "Function", + "tags": [], "label": "getParamDefaults", + "description": [], "signature": [ "() => { lookupEntries: {}[]; unknownKeyValue: null; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.StaticLookupFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(val: any) => any" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.StaticLookupFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(val: any) => any" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", - "lineNumber": 43 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.StringFormat", "type": "Class", "tags": [], @@ -3169,17 +3530,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.StringFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/string.ts", - "lineNumber": 63 - }, "signature": [ { "pluginId": "data", @@ -3188,29 +3551,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 63 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.StringFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", "lineNumber": 64 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.StringFormat.fieldType", "type": "Array", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/string.ts", - "lineNumber": 67 - }, "signature": [ { "pluginId": "data", @@ -3220,77 +3587,88 @@ "text": "KBN_FIELD_TYPES" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 67 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.StringFormat.transformOptions", "type": "Array", + "tags": [], "label": "transformOptions", "description": [], + "signature": [ + "({ kind: boolean; text: string; } | { kind: string; text: string; })[]" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", "lineNumber": 83 }, - "signature": [ - "({ kind: boolean; text: string; } | { kind: string; text: string; })[]" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.StringFormat.getParamDefaults", "type": "Function", + "tags": [], "label": "getParamDefaults", + "description": [], "signature": [ "() => { transform: boolean; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", "lineNumber": 85 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.StringFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(val: any) => any" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 105 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.StringFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", "lineNumber": 105 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(val: any) => any" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/string.ts", - "lineNumber": 105 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/string.ts", - "lineNumber": 62 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.TruncateFormat", "type": "Class", "tags": [], @@ -3313,17 +3691,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/truncate.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.TruncateFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/truncate.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "data", @@ -3332,29 +3712,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/truncate.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.TruncateFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/truncate.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.TruncateFormat.fieldType", "type": "Enum", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/truncate.ts", - "lineNumber": 22 - }, "signature": [ { "pluginId": "data", @@ -3363,47 +3747,54 @@ "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/truncate.ts", + "lineNumber": 22 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.TruncateFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(val: any) => any" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/truncate.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.TruncateFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/truncate.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(val: any) => any" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/truncate.ts", - "lineNumber": 24 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/truncate.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.UrlFormat", "type": "Class", "tags": [], @@ -3426,17 +3817,19 @@ "text": "FieldFormat" } ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.UrlFormat.id", "type": "Enum", + "tags": [], "label": "id", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/url.ts", - "lineNumber": 47 - }, "signature": [ { "pluginId": "data", @@ -3445,29 +3838,33 @@ "section": "def-common.FIELD_FORMAT_IDS", "text": "FIELD_FORMAT_IDS" } - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 47 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.UrlFormat.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", "lineNumber": 48 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.UrlFormat.fieldType", "type": "Array", + "tags": [], "label": "fieldType", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/url.ts", - "lineNumber": 51 - }, "signature": [ { "pluginId": "data", @@ -3477,351 +3874,393 @@ "text": "KBN_FIELD_TYPES" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.UrlFormat.urlTypes", "type": "Array", + "tags": [], "label": "urlTypes", "description": [], + "signature": [ + "{ kind: string; text: string; }[]" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", "lineNumber": 61 }, - "signature": [ - "{ kind: string; text: string; }[]" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.UrlFormat.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.UrlFormat.Unnamed.$1", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "IFieldFormatMetaParams" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", "lineNumber": 63 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/url.ts", - "lineNumber": 63 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.UrlFormat.getParamDefaults", "type": "Function", + "tags": [], "label": "getParamDefaults", + "description": [], "signature": [ "() => { type: string; urlTemplate: null; labelTemplate: null; width: null; height: null; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", "lineNumber": 68 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.UrlFormat.textConvert", "type": "Function", + "tags": [], + "label": "textConvert", + "description": [], + "signature": [ + "(value: any) => string" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 131 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.UrlFormat.textConvert.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", "lineNumber": 131 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any) => string" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/url.ts", - "lineNumber": 131 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.UrlFormat.htmlConvert", "type": "Function", + "tags": [], + "label": "htmlConvert", + "description": [], + "signature": [ + "(rawValue: any, options?: ", + "HtmlContextTypeOptions", + " | undefined) => string" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 133 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.UrlFormat.htmlConvert.$1", "type": "Any", + "tags": [], "label": "rawValue", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", "lineNumber": 133 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.UrlFormat.htmlConvert.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ "HtmlContextTypeOptions", " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", "lineNumber": 133 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(rawValue: any, options?: ", - "HtmlContextTypeOptions", - " | undefined) => string" - ], - "description": [], - "label": "htmlConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/url.ts", - "lineNumber": 133 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/url.ts", - "lineNumber": 46 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "data", "id": "def-common.getHighlightRequest", "type": "Function", + "tags": [], "label": "getHighlightRequest", + "description": [], "signature": [ "(query: any, shouldHighlight: boolean) => { pre_tags: string[]; post_tags: string[]; fields: { '*': {}; }; fragment_size: number; } | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getHighlightRequest.$1", "type": "Any", + "tags": [], "label": "query", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.getHighlightRequest.$2", "type": "boolean", + "tags": [], "label": "shouldHighlight", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts", - "lineNumber": 13 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "data", "id": "def-common.FieldFormatConfig", "type": "Interface", + "tags": [], "label": "FieldFormatConfig", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldFormatConfig.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 63 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldFormatConfig.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 64 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldFormatConfig.es", "type": "CompoundType", + "tags": [], "label": "es", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 65 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 62 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "data", "id": "def-common.FIELD_FORMAT_IDS", "type": "Enum", + "tags": [], "label": "FIELD_FORMAT_IDS", - "tags": [ - "public" - ], "description": [], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 42 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.baseFormatters", "type": "Array", + "tags": [], "label": "baseFormatters", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/constants/base_formatters.ts", - "lineNumber": 28 - }, "signature": [ "FieldFormatInstanceType", "[]" ], + "source": { + "path": "src/plugins/data/common/field_formats/constants/base_formatters.ts", + "lineNumber": 28 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatId", "type": "Type", - "label": "FieldFormatId", "tags": [ "string" ], + "label": "FieldFormatId", "description": [], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 75 }, - "signature": [ - "string" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsContentType", "type": "Type", + "tags": [], "label": "FieldFormatsContentType", - "tags": [ - "public" - ], "description": [], + "signature": [ + "\"html\" | \"text\"" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 14 }, - "signature": [ - "\"html\" | \"text\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsGetConfigFn", "type": "Type", - "label": "FieldFormatsGetConfigFn", "tags": [], + "label": "FieldFormatsGetConfigFn", "description": [], + "signature": [ + "(key: string, defaultOverride: T | undefined) => T" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 68 }, - "signature": [ - "(key: string, defaultOverride: T | undefined) => T" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatsStartCommon", "type": "Type", - "label": "FieldFormatsStartCommon", "tags": [], + "label": "FieldFormatsStartCommon", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 97 - }, "signature": [ "{ init: (getConfig: GetConfigFn, metaParamsOptions?: Record, defaultFieldConverters?: FieldFormatInstanceType[]) => void; register: (fieldFormats: FieldFormatInstanceType[]) => void; deserialize: ", "FormatFactory", @@ -3858,18 +4297,20 @@ "text": "ES_FIELD_TYPES" } ], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 97 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.HTML_CONTEXT_TYPE", "type": "CompoundType", + "tags": [], "label": "HTML_CONTEXT_TYPE", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/content_types/html_content_type.ts", - "lineNumber": 13 - }, "signature": [ { "pluginId": "data", @@ -3879,33 +4320,37 @@ "text": "FieldFormatsContentType" } ], + "source": { + "path": "src/plugins/data/common/field_formats/content_types/html_content_type.ts", + "lineNumber": 13 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IFieldFormat", "type": "Type", - "label": "IFieldFormat", "tags": [], + "label": "IFieldFormat", "description": [], + "signature": [ + "FieldFormat" + ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", "lineNumber": 70 }, - "signature": [ - "FieldFormat" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IFieldFormatsRegistry", "type": "Type", - "label": "IFieldFormatsRegistry", "tags": [], + "label": "IFieldFormatsRegistry", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/index.ts", - "lineNumber": 11 - }, "signature": [ "{ init: (getConfig: ", { @@ -3930,18 +4375,20 @@ "text": "KBN_FIELD_TYPES" } ], + "source": { + "path": "src/plugins/data/common/field_formats/index.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.TEXT_CONTEXT_TYPE", "type": "CompoundType", + "tags": [], "label": "TEXT_CONTEXT_TYPE", "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/content_types/text_content_type.ts", - "lineNumber": 13 - }, "signature": [ { "pluginId": "data", @@ -3951,66 +4398,81 @@ "text": "FieldFormatsContentType" } ], + "source": { + "path": "src/plugins/data/common/field_formats/content_types/text_content_type.ts", + "lineNumber": 13 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "data", "id": "def-common.DEFAULT_CONVERTER_COLOR", "type": "Object", "tags": [], + "label": "DEFAULT_CONVERTER_COLOR", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/constants/color_default.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.DEFAULT_CONVERTER_COLOR.range", "type": "string", + "tags": [], "label": "range", "description": [], "source": { "path": "src/plugins/data/common/field_formats/constants/color_default.ts", "lineNumber": 10 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DEFAULT_CONVERTER_COLOR.regex", "type": "string", + "tags": [], "label": "regex", "description": [], "source": { "path": "src/plugins/data/common/field_formats/constants/color_default.ts", "lineNumber": 11 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DEFAULT_CONVERTER_COLOR.text", "type": "string", + "tags": [], "label": "text", "description": [], "source": { "path": "src/plugins/data/common/field_formats/constants/color_default.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DEFAULT_CONVERTER_COLOR.background", "type": "string", + "tags": [], "label": "background", "description": [], "source": { "path": "src/plugins/data/common/field_formats/constants/color_default.ts", "lineNumber": 13 - } + }, + "deprecated": false } ], - "description": [], - "label": "DEFAULT_CONVERTER_COLOR", - "source": { - "path": "src/plugins/data/common/field_formats/constants/color_default.ts", - "lineNumber": 9 - }, "initialIsOpen": false } ] diff --git a/api_docs/data_index_patterns.json b/api_docs/data_index_patterns.json index 243f7d3a0087e..47d73399e5aef 100644 --- a/api_docs/data_index_patterns.json +++ b/api_docs/data_index_patterns.json @@ -11,26 +11,41 @@ "server": { "classes": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher", "type": "Class", "tags": [], "label": "IndexPatternsFetcher", "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.Unnamed.$1", "type": "CompoundType", + "tags": [], "label": "elasticsearchClient", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -40,38 +55,46 @@ "text": "ElasticsearchClient" } ], - "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.Unnamed.$2", "type": "boolean", + "tags": [], "label": "allowNoIndices", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", - "lineNumber": 39 - } + "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; }) => Promise<", { @@ -83,108 +106,124 @@ }, "[]>" ], - "description": [ - "\n Get a list of field objects for an index pattern that may contain wildcards\n" - ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.pattern", "type": "CompoundType", + "tags": [], "label": "pattern", "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 54 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.metaFields", "type": "Array", + "tags": [], "label": "metaFields", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 55 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.fieldCapsOptions", "type": "Object", + "tags": [], "label": "fieldCapsOptions", "description": [], + "signature": [ + "{ allow_no_indices: boolean; } | undefined" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 56 }, - "signature": [ - "{ allow_no_indices: boolean; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 57 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.rollupIndex", "type": "string", + "tags": [], "label": "rollupIndex", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 58 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", - "lineNumber": 53 - } + ] } ], - "tags": [ - "property", - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", - "lineNumber": 53 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern", "type": "Function", + "tags": [ + "property", + "property", + "property", + "return" + ], "label": "getFieldsForTimePattern", + "description": [ + "\n Get a list of field objects for a time pattern\n" + ], "signature": [ "(options: { pattern: string; metaFields: string[]; lookBack: number; interval: string; }) => Promise<", { @@ -196,126 +235,132 @@ }, "[]>" ], - "description": [ - "\n Get a list of field objects for a time pattern\n" - ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 115 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 115 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.pattern", "type": "string", + "tags": [], "label": "pattern", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 116 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.metaFields", "type": "Array", + "tags": [], "label": "metaFields", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 117 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.lookBack", "type": "number", + "tags": [], "label": "lookBack", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 118 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.interval", "type": "string", + "tags": [], "label": "interval", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 119 - } + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", - "lineNumber": 115 - } + ] } ], - "tags": [ - "property", - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", - "lineNumber": 115 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.validatePatternListActive", "type": "Function", - "label": "validatePatternListActive", - "signature": [ - "(patternList: string[]) => Promise" + "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" + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 136 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsFetcher.validatePatternListActive.$1", "type": "Array", + "tags": [], "label": "patternList", - "isRequired": true, - "signature": [ + "description": [ "string[]" ], - "description": [ + "signature": [ "string[]" ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 136 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", - "lineNumber": 136 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsServiceProvider", "type": "Class", "tags": [], @@ -341,11 +386,19 @@ "IndexPatternsServiceStart", ", object, object>" ], + "source": { + "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", + "lineNumber": 79 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsServiceProvider.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -369,13 +422,19 @@ "IndexPatternsServiceSetupDeps", ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsServiceProvider.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -396,38 +455,40 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsServiceProvider.setup.$2", "type": "Object", + "tags": [], "label": "{ expressions, usageCollection }", - "isRequired": true, + "description": [], "signature": [ "IndexPatternsServiceSetupDeps" ], - "description": [], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", "lineNumber": 82 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", - "lineNumber": 80 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsServiceProvider.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -464,13 +525,19 @@ "text": "IndexPatternsService" } ], - "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", + "lineNumber": 93 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.IndexPatternsServiceProvider.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -480,151 +547,190 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", "lineNumber": 93 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsServiceProvider.start.$2", "type": "Object", + "tags": [], "label": "{ fieldFormats, logger }", - "isRequired": true, + "description": [], "signature": [ "IndexPatternsServiceStartDeps" ], - "description": [], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", "lineNumber": 93 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", - "lineNumber": 93 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", - "lineNumber": 79 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "data", "id": "def-server.getCapabilitiesForRollupIndices", "type": "Function", + "tags": [], "label": "getCapabilitiesForRollupIndices", + "description": [], "signature": [ "(indices: { [key: string]: any; }) => { [key: string]: any; }" ], - "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.getCapabilitiesForRollupIndices.$1.indices", "type": "Object", - "label": "indices", "tags": [], + "label": "indices", "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.getCapabilitiesForRollupIndices.$1.indices.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", "lineNumber": 11 }, - "signature": [ - "any" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", - "lineNumber": 11 - } + ] } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.mergeCapabilitiesWithFields", "type": "Function", - "children": [ + "tags": [], + "label": "mergeCapabilitiesWithFields", + "description": [], + "signature": [ + "(rollupIndexCapabilities: { [key: string]: any; }, fieldsFromFieldCapsApi: { [key: string]: any; }, previousFields?: ", { - "id": "def-server.mergeCapabilitiesWithFields.$1.rollupIndexCapabilities", - "type": "Object", - "label": "rollupIndexCapabilities", + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.FieldDescriptor", + "text": "FieldDescriptor" + }, + "[]) => ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.FieldDescriptor", + "text": "FieldDescriptor" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", + "lineNumber": 13 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.mergeCapabilitiesWithFields.$1.rollupIndexCapabilities", + "type": "Object", "tags": [], + "label": "rollupIndexCapabilities", "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.mergeCapabilitiesWithFields.$1.rollupIndexCapabilities.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", "lineNumber": 14 }, - "signature": [ - "any" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", - "lineNumber": 14 - } + ] }, { + "parentPluginId": "data", "id": "def-server.mergeCapabilitiesWithFields.$2.fieldsFromFieldCapsApi", "type": "Object", - "label": "fieldsFromFieldCapsApi", "tags": [], + "label": "fieldsFromFieldCapsApi", "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.mergeCapabilitiesWithFields.$2.fieldsFromFieldCapsApi.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", "lineNumber": 15 }, - "signature": [ - "any" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", - "lineNumber": 15 - } + ] }, { + "parentPluginId": "data", "id": "def-server.mergeCapabilitiesWithFields.$3", "type": "Array", + "tags": [], "label": "previousFields", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -635,282 +741,297 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(rollupIndexCapabilities: { [key: string]: any; }, fieldsFromFieldCapsApi: { [key: string]: any; }, previousFields?: ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" - }, - "[]) => ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" - }, - "[]" - ], - "description": [], - "label": "mergeCapabilitiesWithFields", - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", - "lineNumber": 13 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.shouldReadFieldFromDocValues", "type": "Function", + "tags": [], "label": "shouldReadFieldFromDocValues", + "description": [], "signature": [ "(aggregatable: boolean, esType: string) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.shouldReadFieldFromDocValues.$1", "type": "boolean", + "tags": [], "label": "aggregatable", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.shouldReadFieldFromDocValues.$2", "type": "string", + "tags": [], "label": "esType", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", - "lineNumber": 9 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "data", "id": "def-server.FieldDescriptor", "type": "Interface", + "tags": [], "label": "FieldDescriptor", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.aggregatable", "type": "boolean", + "tags": [], "label": "aggregatable", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.readFromDocValues", "type": "boolean", + "tags": [], "label": "readFromDocValues", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.searchable", "type": "boolean", + "tags": [], "label": "searchable", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.esTypes", "type": "Array", + "tags": [], "label": "esTypes", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 26 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.subType", "type": "Object", + "tags": [], "label": "subType", "description": [], + "signature": [ + "FieldSubType | undefined" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 27 }, - "signature": [ - "FieldSubType | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.FieldDescriptor", "type": "Interface", + "tags": [], "label": "FieldDescriptor", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.aggregatable", "type": "boolean", + "tags": [], "label": "aggregatable", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.readFromDocValues", "type": "boolean", + "tags": [], "label": "readFromDocValues", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.searchable", "type": "boolean", + "tags": [], "label": "searchable", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.esTypes", "type": "Array", + "tags": [], "label": "esTypes", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 26 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.FieldDescriptor.subType", "type": "Object", + "tags": [], "label": "subType", "description": [], + "signature": [ + "FieldSubType | undefined" + ], "source": { "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", "lineNumber": 27 }, - "signature": [ - "FieldSubType | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", - "lineNumber": 20 - }, "initialIsOpen": false } ], @@ -921,6 +1042,7 @@ "common": { "classes": [ { + "parentPluginId": "data", "id": "def-common.DuplicateIndexPatternError", "type": "Class", "tags": [], @@ -936,46 +1058,53 @@ }, " extends Error" ], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.DuplicateIndexPatternError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.DuplicateIndexPatternError.Unnamed.$1", "type": "string", + "tags": [], "label": "message", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", "lineNumber": 10 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", - "lineNumber": 10 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IndexPattern", "type": "Class", "tags": [], @@ -998,58 +1127,66 @@ "text": "IIndexPattern" } ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 45 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 46 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.fieldFormatMap", "type": "Object", + "tags": [], "label": "fieldFormatMap", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 47 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.typeMeta", "type": "Object", + "tags": [], "label": "typeMeta", "description": [ "\nOnly used by rollup indices, used by rollup specific endpoint to load field list" ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 51 - }, "signature": [ { "pluginId": "data", @@ -1059,18 +1196,20 @@ "text": "TypeMeta" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.fields", "type": "CompoundType", + "tags": [], "label": "fields", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 52 - }, "signature": [ { "pluginId": "data", @@ -1088,136 +1227,155 @@ "text": "FieldSpec" }, ">; }" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 52 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 53 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.IndexPattern.intervalName", + "type": "string", "tags": [ "deprecated" ], - "id": "def-common.IndexPattern.intervalName", - "type": "string", "label": "intervalName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 58 }, - "signature": [ - "string | undefined" - ] + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nType is used to identify rollup index patterns" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 62 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.formatHit", "type": "Function", + "tags": [], "label": "formatHit", "description": [], + "signature": [ + "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 63 }, - "signature": [ - "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.formatField", "type": "Function", + "tags": [], "label": "formatField", "description": [], + "signature": [ + "FormatFieldFn" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 67 }, - "signature": [ - "FormatFieldFn" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.flattenHit", "type": "Function", + "tags": [], "label": "flattenHit", "description": [], + "signature": [ + "(hit: Record, deep?: boolean | undefined) => Record" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 68 }, - "signature": [ - "(hit: Record, deep?: boolean | undefined) => Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.metaFields", "type": "Array", + "tags": [], "label": "metaFields", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 69 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.version", "type": "string", + "tags": [], "label": "version", "description": [ "\nSavedObject version" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 73 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.sourceFilters", "type": "Array", + "tags": [], "label": "sourceFilters", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 74 - }, "signature": [ { "pluginId": "data", @@ -1227,12 +1385,18 @@ "text": "SourceFilter" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 74 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPattern.allowNoIndex", "type": "boolean", + "tags": [], "label": "allowNoIndex", "description": [ "\nprevents errors when index pattern exists before indices" @@ -1240,79 +1404,92 @@ "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 84 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.Unnamed.$1", "type": "Object", + "tags": [], "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", - "isRequired": true, + "description": [], "signature": [ "IndexPatternDeps" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 86 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getOriginalSavedObjectBody", "type": "Function", - "children": [], - "signature": [ - "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" - ], + "tags": [], + "label": "getOriginalSavedObjectBody", "description": [ "\nGet last saved saved object fields" ], - "label": "getOriginalSavedObjectBody", + "signature": [ + "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 128 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.resetOriginalSavedObjectBody", "type": "Function", - "children": [], - "signature": [ - "() => void" - ], + "tags": [], + "label": "resetOriginalSavedObjectBody", "description": [ "\nReset last saved saved object fields. used after saving" ], - "label": "resetOriginalSavedObjectBody", + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 133 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getFieldAttrs", "type": "Function", - "children": [], + "tags": [], + "label": "getFieldAttrs", + "description": [], "signature": [ "() => { [x: string]: ", { @@ -1324,19 +1501,21 @@ }, "; }" ], - "description": [], - "label": "getFieldAttrs", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 137 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getComputedFields", "type": "Function", + "tags": [], "label": "getComputedFields", + "description": [], "signature": [ "() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 162 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.toSpec", "type": "Function", + "tags": [], "label": "toSpec", + "description": [ + "\nCreate static representation of index pattern" + ], "signature": [ "() => ", { @@ -1371,137 +1554,155 @@ "text": "IndexPatternSpec" } ], - "description": [ - "\nCreate static representation of index pattern" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getSourceFiltering", "type": "Function", + "tags": [], "label": "getSourceFiltering", - "signature": [ - "() => { excludes: any[]; }" - ], "description": [ "\nGet the source filtering configuration for that index." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => { excludes: any[]; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 230 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.addScriptedField", "type": "Function", + "tags": [], "label": "addScriptedField", - "signature": [ - "(name: string, script: string, fieldType?: string) => Promise" - ], "description": [ "\nAdd scripted field to field list\n" ], + "signature": [ + "(name: string, script: string, fieldType?: string) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.addScriptedField.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "field name" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.addScriptedField.$2", "type": "string", + "tags": [], "label": "script", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "script code" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.addScriptedField.$3", "type": "string", + "tags": [], "label": "fieldType", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 244 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.removeScriptedField", "type": "Function", + "tags": [], "label": "removeScriptedField", - "signature": [ - "(fieldName: string) => void" - ], "description": [ "\nRemove scripted field from field list" ], + "signature": [ + "(fieldName: string) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.removeScriptedField.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 270 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 270 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getNonScriptedFields", "type": "Function", + "tags": [], "label": "getNonScriptedFields", + "description": [], "signature": [ "() => ", { @@ -1513,19 +1714,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 277 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getScriptedFields", "type": "Function", + "tags": [], "label": "getScriptedFields", + "description": [], "signature": [ "() => ", { @@ -1537,51 +1740,57 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 281 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.isTimeBased", "type": "Function", + "tags": [], "label": "isTimeBased", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 285 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.isTimeNanosBased", "type": "Function", + "tags": [], "label": "isTimeNanosBased", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 289 - } - }, - { + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", "id": "def-common.IndexPattern.getTimeField", "type": "Function", + "tags": [], "label": "getTimeField", + "description": [], "signature": [ "() => ", { @@ -1593,19 +1802,21 @@ }, " | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 294 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getFieldByName", "type": "Function", + "tags": [], "label": "getFieldByName", + "description": [], "signature": [ "(name: string) => ", { @@ -1617,68 +1828,79 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.getFieldByName.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 299 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 299 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getAggregationRestrictions", "type": "Function", + "tags": [], "label": "getAggregationRestrictions", + "description": [], "signature": [ "() => Record> | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 304 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getAsSavedObjectBody", "type": "Function", + "tags": [], "label": "getAsSavedObjectBody", - "signature": [ - "() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }" - ], "description": [ "\nReturns index pattern as saved object body for saving" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 311 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getFormatterForField", "type": "Function", + "tags": [], "label": "getFormatterForField", + "description": [ + "\nProvide a field, get its formatter" + ], "signature": [ "(field: ", { @@ -1713,15 +1935,19 @@ "text": "FieldFormat" } ], - "description": [ - "\nProvide a field, get its formatter" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 339 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.getFormatterForField.$1", "type": "CompoundType", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1747,24 +1973,25 @@ "text": "FieldSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 340 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 339 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.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: ", { @@ -1776,31 +2003,40 @@ }, ") => void" ], - "description": [ - "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.addRuntimeField.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Field name" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 360 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.addRuntimeField.$2", "type": "Object", + "tags": [], "label": "runtimeField", - "isRequired": true, + "description": [ + "Runtime field definition" + ], "signature": [ { "pluginId": "data", @@ -1810,61 +2046,65 @@ "text": "RuntimeField" } ], - "description": [ - "Runtime field definition" - ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 360 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.removeRuntimeField", "type": "Function", + "tags": [], "label": "removeRuntimeField", - "signature": [ - "(name: string) => void" - ], "description": [ "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate" ], + "signature": [ + "(name: string) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.removeRuntimeField.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Field name" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 384 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 384 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.getFormatterForFieldNoDefault", "type": "Function", + "tags": [], "label": "getFormatterForFieldNoDefault", + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists" + ], "signature": [ "(fieldname: string) => ", { @@ -1876,36 +2116,39 @@ }, " | undefined" ], - "description": [ - "\nGet formatter for a given field name. Return undefined if none exists" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.getFormatterForFieldNoDefault.$1", "type": "string", + "tags": [], "label": "fieldname", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 404 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 404 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldAttrs", "type": "Function", + "tags": [], "label": "setFieldAttrs", + "description": [], "signature": [ "(fieldName: string, attrName: K, value: ", { @@ -1917,41 +2160,53 @@ }, "[K]) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 411 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldAttrs.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 412 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldAttrs.$2", "type": "Uncategorized", + "tags": [], "label": "attrName", - "isRequired": true, + "description": [], "signature": [ "K" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 413 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldAttrs.$3", "type": "Uncategorized", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1962,133 +2217,170 @@ }, "[K]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 414 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 411 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldCustomLabel", "type": "Function", + "tags": [], "label": "setFieldCustomLabel", + "description": [], "signature": [ "(fieldName: string, customLabel: string | null | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldCustomLabel.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 422 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldCustomLabel.$2", "type": "CompoundType", + "tags": [], "label": "customLabel", - "isRequired": false, + "description": [], "signature": [ "string | null | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 422 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldCount", "type": "Function", + "tags": [], "label": "setFieldCount", + "description": [], "signature": [ "(fieldName: string, count: number | null | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldCount.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 433 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldCount.$2", "type": "CompoundType", + "tags": [], "label": "count", - "isRequired": false, + "description": [], "signature": [ "number | null | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 433 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldFormat", "type": "Function", + "tags": [], + "label": "setFieldFormat", + "description": [], + "signature": [ + "(fieldName: string, format: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldFormat.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 446 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.setFieldFormat.$2", "type": "Object", + "tags": [], "label": "format", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -2099,72 +2391,57 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 446 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(fieldName: string, format: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - ">) => void" - ], - "description": [], - "label": "setFieldFormat", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPattern.deleteFieldFormat", "type": "Function", - "children": [ - { - "id": "def-common.IndexPattern.deleteFieldFormat.$1", + "tags": [], + "label": "deleteFieldFormat", + "description": [], + "signature": [ + "(fieldName: string) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.IndexPattern.deleteFieldFormat.$1", "type": "string", + "tags": [], "label": "fieldName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 450 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(fieldName: string) => void" - ], - "description": [], - "label": "deleteFieldFormat", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 450 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField", "type": "Class", "tags": [], @@ -2187,17 +2464,19 @@ "text": "IFieldType" } ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternField.spec", "type": "Object", + "tags": [], "label": "spec", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 17 - }, "signature": [ { "pluginId": "data", @@ -2206,22 +2485,36 @@ "section": "def-common.FieldSpec", "text": "FieldSpec" } - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 17 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternField.Unnamed.$1", "type": "Object", + "tags": [], "label": "spec", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -2231,54 +2524,51 @@ "text": "FieldSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 21 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.count", "type": "number", - "label": "count", "tags": [], + "label": "count", "description": [ "\nCount is used for field popularity" ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.count", "type": "number", - "label": "count", "tags": [], + "label": "count", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 35 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.runtimeField", "type": "Object", - "label": "runtimeField", "tags": [], + "label": "runtimeField", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 39 - }, "signature": [ { "pluginId": "data", @@ -2288,18 +2578,20 @@ "text": "RuntimeField" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 39 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.runtimeField", "type": "Object", - "label": "runtimeField", "tags": [], + "label": "runtimeField", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 43 - }, "signature": [ { "pluginId": "data", @@ -2309,227 +2601,261 @@ "text": "RuntimeField" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 43 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.script", "type": "string", - "label": "script", "tags": [], + "label": "script", "description": [ "\nScript field code" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 50 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.script", "type": "string", - "label": "script", "tags": [], + "label": "script", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 54 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.lang", "type": "string", - "label": "lang", "tags": [], + "label": "lang", "description": [ "\nScript field language" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 61 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.lang", "type": "string", - "label": "lang", "tags": [], + "label": "lang", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 65 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.customLabel", "type": "string", - "label": "customLabel", "tags": [], + "label": "customLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 69 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.customLabel", "type": "string", - "label": "customLabel", "tags": [], + "label": "customLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 73 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.conflictDescriptions", "type": "Object", - "label": "conflictDescriptions", "tags": [], + "label": "conflictDescriptions", "description": [ "\nDescription of field type conflicts across different indices in the same index pattern" ], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 80 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.conflictDescriptions", "type": "Object", - "label": "conflictDescriptions", "tags": [], + "label": "conflictDescriptions", "description": [], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 84 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.name", "type": "string", - "label": "name", "tags": [], + "label": "name", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 89 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.displayName", "type": "string", - "label": "displayName", "tags": [], + "label": "displayName", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 93 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.type", "type": "string", - "label": "type", "tags": [], + "label": "type", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 101 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.esTypes", "type": "Array", - "label": "esTypes", "tags": [], + "label": "esTypes", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 107 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.scripted", "type": "boolean", - "label": "scripted", "tags": [], + "label": "scripted", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 111 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.searchable", "type": "boolean", - "label": "searchable", "tags": [], + "label": "searchable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 115 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.aggregatable", "type": "boolean", - "label": "aggregatable", "tags": [], + "label": "aggregatable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 119 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.readFromDocValues", "type": "boolean", - "label": "readFromDocValues", "tags": [], + "label": "readFromDocValues", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 123 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.subType", "type": "Object", - "label": "subType", "tags": [], + "label": "subType", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 127 - }, "signature": [ { "pluginId": "data", @@ -2539,77 +2865,95 @@ "text": "IFieldSubType" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 127 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.isMapped", "type": "CompoundType", - "label": "isMapped", "tags": [], + "label": "isMapped", "description": [ "\nIs the field part of the index mapping?" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 134 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.sortable", "type": "boolean", - "label": "sortable", "tags": [], + "label": "sortable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 139 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.filterable", "type": "boolean", - "label": "filterable", "tags": [], + "label": "filterable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 146 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.visualizable", "type": "boolean", - "label": "visualizable", "tags": [], + "label": "visualizable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 154 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.deleteCount", "type": "Function", + "tags": [], "label": "deleteCount", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 159 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.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: ", { @@ -2621,19 +2965,21 @@ }, " | undefined; customLabel: string | undefined; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", "lineNumber": 163 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternField.toSpec", "type": "Function", + "tags": [], "label": "toSpec", + "description": [], "signature": [ "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", { @@ -2676,25 +3022,32 @@ "text": "FieldSpec" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 181 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternField.toSpec.$1.getFormatterForField", "type": "Object", - "label": "{\n getFormatterForField,\n }", "tags": [], + "label": "{\n getFormatterForField,\n }", "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 183 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternField.toSpec.$1.getFormatterForField.getFormatterForField", "type": "Function", + "tags": [], "label": "getFormatterForField", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 184 - }, "signature": [ "((field: ", { @@ -2729,274 +3082,310 @@ "text": "FieldFormat" }, ") | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 184 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 183 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 181 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService", "type": "Class", "tags": [], "label": "IndexPatternsService", "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternsService.ensureDefaultIndexPattern", "type": "Function", + "tags": [], "label": "ensureDefaultIndexPattern", "description": [], + "signature": [ + "EnsureDefaultIndexPattern" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "signature": [ - "EnsureDefaultIndexPattern" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.Unnamed.$1", "type": "Object", + "tags": [], "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", - "isRequired": true, + "description": [], "signature": [ "IndexPatternsServiceDeps" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 69 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 69 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getIds", "type": "Function", + "tags": [], + "label": "getIds", + "description": [ + "\nGet list of index pattern ids" + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getIds.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 108 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.IndexPatternsService.getTitles", + "type": "Function", + "tags": [], + "label": "getTitles", + "description": [ + "\nGet list of index pattern titles" + ], "signature": [ "(refresh?: boolean) => Promise" ], - "description": [ - "\nGet list of index pattern ids" - ], - "label": "getIds", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 108 + "lineNumber": 122 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.IndexPatternsService.getTitles", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getTitles.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 122 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(refresh?: boolean) => Promise" - ], - "description": [ - "\nGet list of index pattern titles" - ], - "label": "getTitles", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 122 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.find", "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nFind and load index patterns by title" + ], + "signature": [ + "(search: string, size?: number) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "[]>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.find.$1", "type": "string", + "tags": [], "label": "search", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.find.$2", "type": "number", + "tags": [], "label": "size", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(search: string, size?: number) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - "[]>" - ], - "description": [ - "\nFind and load index patterns by title" - ], - "label": "find", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 138 - }, - "tags": [], "returnComment": [ "IndexPattern[]" ] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getIdsWithTitle", "type": "Function", + "tags": [], + "label": "getIdsWithTitle", + "description": [ + "\nGet list of index pattern ids with titles" + ], + "signature": [ + "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 156 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getIdsWithTitle.$1", "type": "boolean", + "tags": [], "label": "refresh", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 157 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" - ], - "description": [ - "\nGet list of index pattern ids with titles" - ], - "label": "getIdsWithTitle", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 156 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.clearCache", "type": "Function", + "tags": [], + "label": "clearCache", + "description": [ + "\nClear index pattern list cache" + ], + "signature": [ + "(id?: string | undefined) => void" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.clearCache.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 175 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(id?: string | undefined) => void" - ], - "description": [ - "\nClear index pattern list cache" - ], - "label": "clearCache", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 175 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getCache", "type": "Function", - "children": [], + "tags": [], + "label": "getCache", + "description": [], "signature": [ "() => Promise<", "SavedObject", @@ -3004,19 +3393,23 @@ "IndexPatternSavedObjectAttrs", ">[] | null | undefined>" ], - "description": [], - "label": "getCache", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 184 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getDefault", "type": "Function", - "children": [], + "tags": [], + "label": "getDefault", + "description": [ + "\nGet default index pattern" + ], "signature": [ "() => Promise<", { @@ -3028,73 +3421,102 @@ }, " | null>" ], - "description": [ - "\nGet default index pattern" - ], - "label": "getDefault", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 194 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.setDefault", "type": "Function", + "tags": [], + "label": "setDefault", + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], + "signature": [ + "(id: string, force?: boolean) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.setDefault.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.setDefault.$2", "type": "boolean", + "tags": [], "label": "force", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(id: string, force?: boolean) => Promise" - ], - "description": [ - "\nOptionally set default index pattern, unless force = true" - ], - "label": "setDefault", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 208 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getFieldsForWildcard", "type": "Function", + "tags": [], + "label": "getFieldsForWildcard", + "description": [ + "\nGet field list by providing { pattern }" + ], + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getFieldsForWildcard.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3104,15 +3526,45 @@ "text": "GetFieldsOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 219 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-common.IndexPatternsService.getFieldsForIndexPattern", + "type": "Function", + "tags": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet field list by providing an index patttern (or spec)" + ], "signature": [ - "(options: ", + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", options?: ", { "pluginId": "data", "scope": "common", @@ -3120,30 +3572,21 @@ "section": "def-common.GetFieldsOptions", "text": "GetFieldsOptions" }, - ") => Promise" - ], - "description": [ - "\nGet field list by providing { pattern }" + " | undefined) => Promise" ], - "label": "getFieldsForWildcard", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 219 + "lineNumber": 235 }, - "tags": [], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "id": "def-common.IndexPatternsService.getFieldsForIndexPattern", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getFieldsForIndexPattern.$1", "type": "CompoundType", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3161,17 +3604,20 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 236 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.getFieldsForIndexPattern.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -3182,13 +3628,27 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 237 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-common.IndexPatternsService.refreshFields", + "type": "Function", + "tags": [], + "label": "refreshFields", + "description": [ + "\nRefresh field list for a given index pattern" + ], "signature": [ "(indexPattern: ", { @@ -3198,46 +3658,21 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" }, - " | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - }, - ", options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise" - ], - "description": [ - "\nGet field list by providing an index patttern (or spec)" + ") => Promise" ], - "label": "getFieldsForIndexPattern", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 235 + "lineNumber": 250 }, - "tags": [], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "id": "def-common.IndexPatternsService.refreshFields", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.refreshFields.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3247,44 +3682,65 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 250 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.IndexPatternsService.fieldArrayToMap", + "type": "Function", + "tags": [], + "label": "fieldArrayToMap", + "description": [ + "\nConverts field array to map" + ], "signature": [ - "(indexPattern: ", + "(fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" }, - ") => Promise" - ], - "description": [ - "\nRefresh field list for a given index pattern" + " | undefined) => Record" ], - "label": "refreshFields", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 250 + "lineNumber": 327 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.IndexPatternsService.fieldArrayToMap", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.fieldArrayToMap.$1", "type": "Array", + "tags": [], "label": "fields", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3295,17 +3751,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 327 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.fieldArrayToMap.$2", "type": "Object", + "tags": [], "label": "fieldAttrs", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -3316,62 +3775,60 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 327 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [ + "Record" + ] + }, + { + "parentPluginId": "data", + "id": "def-common.IndexPatternsService.savedObjectToSpec", + "type": "Function", + "tags": [], + "label": "savedObjectToSpec", + "description": [ + "\nConverts index pattern saved object to index pattern spec" + ], "signature": [ - "(fields: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", + "(savedObject: ", + "SavedObject", + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" }, - " | undefined) => Record) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ">" - ], - "description": [ - "\nConverts field array to map" + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } ], - "label": "fieldArrayToMap", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 327 + "lineNumber": 343 }, - "tags": [], - "returnComment": [ - "Record" - ] - }, - { - "id": "def-common.IndexPatternsService.savedObjectToSpec", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.savedObjectToSpec.$1", "type": "Object", + "tags": [], "label": "savedObject", - "isRequired": true, + "description": [], "signature": [ "SavedObject", "<", @@ -3384,64 +3841,26 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 343 - } - } - ], - "signature": [ - "(savedObject: ", - "SavedObject", - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternAttributes", - "text": "IndexPatternAttributes" - }, - ">) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" + }, + "deprecated": false, + "isRequired": true } ], - "description": [ - "\nConverts index pattern saved object to index pattern spec" - ], - "label": "savedObjectToSpec", - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 343 - }, - "tags": [], "returnComment": [ "IndexPatternSpec" ] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.get", "type": "Function", - "children": [ - { - "id": "def-common.IndexPatternsService.get.$1", - "type": "string", - "label": "id", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 465 - } - } + "tags": [], + "label": "get", + "description": [ + "\nGet an index pattern by id. Cache optimized" ], "signature": [ "(id: string) => Promise<", @@ -3454,21 +3873,41 @@ }, ">" ], - "description": [ - "\nGet an index pattern by id. Cache optimized" - ], - "label": "get", "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 465 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.IndexPatternsService.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 465 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.create", "type": "Function", + "tags": [], "label": "create", + "description": [ + "\nCreate a new index pattern instance" + ], "signature": [ "(spec: ", { @@ -3488,15 +3927,19 @@ }, ">" ], - "description": [ - "\nCreate a new index pattern instance" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 484 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.create.$1", "type": "Object", + "tags": [], "label": "spec", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3506,40 +3949,44 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 484 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.create.$2", "type": "boolean", + "tags": [], "label": "skipFetchFields", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 484 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "IndexPattern" - ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 484 - } + ] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.createAndSave", "type": "Function", + "tags": [], "label": "createAndSave", + "description": [ + "\nCreate a new index pattern and save it right away" + ], "signature": [ "(spec: ", { @@ -3559,15 +4006,19 @@ }, ">" ], - "description": [ - "\nCreate a new index pattern and save it right away" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 509 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.createAndSave.$1", "type": "Object", + "tags": [], "label": "spec", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3577,56 +4028,63 @@ "text": "IndexPatternSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.createAndSave.$2", "type": "boolean", + "tags": [], "label": "override", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Overwrite if existing index pattern exists." ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.createAndSave.$3", "type": "boolean", + "tags": [], "label": "skipFetchFields", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Whether to skip field refresh step." ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 509 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 509 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.createSavedObject", "type": "Function", + "tags": [], "label": "createSavedObject", + "description": [ + "\nSave a new index pattern" + ], "signature": [ "(indexPattern: ", { @@ -3646,15 +4104,19 @@ }, ">" ], - "description": [ - "\nSave a new index pattern" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 522 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.createSavedObject.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3664,40 +4126,44 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 522 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.createSavedObject.$2", "type": "boolean", + "tags": [], "label": "override", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "Overwrite if existing index pattern exists" ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 522 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 522 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.updateSavedObject", "type": "Function", + "tags": [], "label": "updateSavedObject", + "description": [ + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + ], "signature": [ "(indexPattern: ", { @@ -3709,15 +4175,19 @@ }, ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], - "description": [ - "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" - ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 550 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.updateSavedObject.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3727,101 +4197,133 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 551 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.updateSavedObject.$2", "type": "number", + "tags": [], "label": "saveAttempts", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 552 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.updateSavedObject.$3", "type": "boolean", + "tags": [], "label": "ignoreErrors", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 553 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 550 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.delete", "type": "Function", + "tags": [], "label": "delete", - "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], "description": [ "\nDeletes an index pattern from .kibana index" ], + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 636 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IndexPatternsService.delete.$1", "type": "string", + "tags": [], "label": "indexPatternId", - "isRequired": true, - "signature": [ - "string" - ], "description": [ ": Id of kibana Index Pattern to delete" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 636 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 636 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 57 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "data", "id": "def-common.fieldList", "type": "Function", + "tags": [], + "label": "fieldList", + "description": [], + "signature": [ + "(specs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], shortDotsEnable?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.fieldList.$1", "type": "Array", + "tags": [], "label": "specs", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3832,59 +4334,41 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.fieldList.$2", "type": "boolean", + "tags": [], "label": "shortDotsEnable", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 36 - } - } - ], - "signature": [ - "(specs?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], shortDotsEnable?: boolean) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "fieldList", - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 34 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getIndexPatternLoadMeta", "type": "Function", - "children": [], + "tags": [], + "label": "getIndexPatternLoadMeta", + "description": [], "signature": [ "() => Pick<", { @@ -3896,20 +4380,22 @@ }, ", \"type\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"name\" | \"disabled\" | \"help\" | \"inputTypes\" | \"args\" | \"aliases\" | \"context\">" ], - "description": [], - "label": "getIndexPatternLoadMeta", "source": { "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", "lineNumber": 42 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isFilterable", "type": "Function", + "tags": [], "label": "isFilterable", + "description": [], "signature": [ "(field: ", { @@ -3921,13 +4407,19 @@ }, ") => boolean" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isFilterable.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3937,25 +4429,24 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/utils.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/utils.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isNestedField", "type": "Function", + "tags": [], "label": "isNestedField", + "description": [], "signature": [ "(field: ", { @@ -3967,13 +4458,19 @@ }, ") => boolean" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isNestedField.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3983,176 +4480,193 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/utils.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/utils.ts", - "lineNumber": 22 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "data", "id": "def-common.FieldAttrs", "type": "Interface", - "label": "FieldAttrs", - "description": [], "tags": [ "intenal" ], + "label": "FieldAttrs", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldAttrs.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 75 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 74 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldAttrSet", "type": "Interface", + "tags": [], "label": "FieldAttrSet", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 78 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldAttrSet.customLabel", "type": "string", + "tags": [], "label": "customLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 79 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldAttrSet.count", "type": "number", + "tags": [], "label": "count", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 80 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 78 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldSpec", "type": "Interface", + "tags": [], "label": "FieldSpec", "description": [ "\nSerialized version of IndexPatternField" ], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 186 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.count", "type": "number", + "tags": [], "label": "count", "description": [ "\nPopularity count is used by discover" ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 190 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.script", "type": "string", + "tags": [], "label": "script", "description": [ "\nScripted field painless script" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 194 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.lang", "type": "string", + "tags": [], "label": "lang", "description": [ "\nScripted field langauge\nPainless is the only valid scripted field language" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 199 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.conflictDescriptions", "type": "Object", + "tags": [], "label": "conflictDescriptions", "description": [], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 200 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.format", "type": "Object", + "tags": [], "label": "format", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 201 - }, "signature": [ { "pluginId": "expressions", @@ -4162,104 +4676,120 @@ "text": "SerializedFieldFormat" }, "> | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 201 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 202 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 203 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.esTypes", "type": "Array", + "tags": [], "label": "esTypes", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 204 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.scripted", "type": "CompoundType", + "tags": [], "label": "scripted", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 205 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.searchable", "type": "boolean", + "tags": [], "label": "searchable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 206 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.aggregatable", "type": "boolean", + "tags": [], "label": "aggregatable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 207 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.readFromDocValues", "type": "CompoundType", + "tags": [], "label": "readFromDocValues", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 208 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.subType", "type": "Object", + "tags": [], "label": "subType", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 209 - }, "signature": [ { "pluginId": "data", @@ -4269,46 +4799,52 @@ "text": "IFieldSubType" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 209 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.indexed", "type": "CompoundType", + "tags": [], "label": "indexed", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 210 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.customLabel", "type": "string", + "tags": [], "label": "customLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 211 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.runtimeField", "type": "Object", + "tags": [], "label": "runtimeField", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 212 - }, "signature": [ { "pluginId": "data", @@ -4318,127 +4854,145 @@ "text": "RuntimeField" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 212 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.shortDotsEnable", "type": "CompoundType", + "tags": [], "label": "shortDotsEnable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 214 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpec.isMapped", "type": "CompoundType", + "tags": [], "label": "isMapped", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 215 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 186 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt", "type": "Interface", + "tags": [], "label": "FieldSpecExportFmt", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 166 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.count", "type": "number", + "tags": [], "label": "count", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 167 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.script", "type": "string", + "tags": [], "label": "script", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 168 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.lang", "type": "string", + "tags": [], "label": "lang", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 169 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.conflictDescriptions", "type": "Object", + "tags": [], "label": "conflictDescriptions", "description": [], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 170 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 171 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.type", "type": "Enum", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 172 - }, "signature": [ { "pluginId": "data", @@ -4447,79 +5001,91 @@ "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" } - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 172 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.esTypes", "type": "Array", + "tags": [], "label": "esTypes", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 173 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.scripted", "type": "boolean", + "tags": [], "label": "scripted", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 174 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.searchable", "type": "boolean", + "tags": [], "label": "searchable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 175 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.aggregatable", "type": "boolean", + "tags": [], "label": "aggregatable", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 176 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.readFromDocValues", "type": "CompoundType", + "tags": [], "label": "readFromDocValues", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 177 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.subType", "type": "Object", + "tags": [], "label": "subType", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 178 - }, "signature": [ { "pluginId": "data", @@ -4529,18 +5095,20 @@ "text": "IFieldSubType" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 178 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.format", "type": "Object", + "tags": [], "label": "format", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 179 - }, "signature": [ { "pluginId": "expressions", @@ -4550,420 +5118,482 @@ "text": "SerializedFieldFormat" }, "> | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 179 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldSpecExportFmt.indexed", "type": "CompoundType", + "tags": [], "label": "indexed", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 180 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 166 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.GetFieldsOptions", "type": "Interface", + "tags": [], "label": "GetFieldsOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 118 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.GetFieldsOptions.pattern", "type": "string", + "tags": [], "label": "pattern", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 119 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.GetFieldsOptions.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 120 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.GetFieldsOptions.lookBack", "type": "CompoundType", + "tags": [], "label": "lookBack", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 121 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.GetFieldsOptions.metaFields", "type": "Array", + "tags": [], "label": "metaFields", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 122 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.GetFieldsOptions.rollupIndex", "type": "string", + "tags": [], "label": "rollupIndex", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 123 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.GetFieldsOptions.allowNoIndex", "type": "CompoundType", + "tags": [], "label": "allowNoIndex", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 124 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 118 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.GetFieldsOptionsTimePattern", "type": "Interface", + "tags": [], "label": "GetFieldsOptionsTimePattern", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 127 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.GetFieldsOptionsTimePattern.pattern", "type": "string", + "tags": [], "label": "pattern", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 128 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.GetFieldsOptionsTimePattern.metaFields", "type": "Array", + "tags": [], "label": "metaFields", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 129 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.GetFieldsOptionsTimePattern.lookBack", "type": "number", + "tags": [], "label": "lookBack", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 130 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.GetFieldsOptionsTimePattern.interval", "type": "string", + "tags": [], "label": "interval", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 131 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 127 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IFieldSubType", "type": "Interface", + "tags": [], "label": "IFieldSubType", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 153 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldSubType.multi", "type": "Object", + "tags": [], "label": "multi", "description": [], + "signature": [ + "{ parent: string; } | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 154 }, - "signature": [ - "{ parent: string; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldSubType.nested", "type": "Object", + "tags": [], "label": "nested", "description": [], + "signature": [ + "{ path: string; } | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 155 }, - "signature": [ - "{ path: string; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 153 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IFieldType", "type": "Interface", + "tags": [], "label": "IFieldType", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.script", "type": "string", + "tags": [], "label": "script", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 14 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.lang", "type": "string", + "tags": [], "label": "lang", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 15 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.count", "type": "number", + "tags": [], "label": "count", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 16 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.esTypes", "type": "Array", + "tags": [], "label": "esTypes", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 19 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.aggregatable", "type": "CompoundType", + "tags": [], "label": "aggregatable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 20 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.filterable", "type": "CompoundType", + "tags": [], "label": "filterable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 21 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.searchable", "type": "CompoundType", + "tags": [], "label": "searchable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 22 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.sortable", "type": "CompoundType", + "tags": [], "label": "sortable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 23 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.visualizable", "type": "CompoundType", + "tags": [], "label": "visualizable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 24 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.readFromDocValues", "type": "CompoundType", + "tags": [], "label": "readFromDocValues", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 25 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.scripted", "type": "CompoundType", + "tags": [], "label": "scripted", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 26 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.subType", "type": "Object", + "tags": [], "label": "subType", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "lineNumber": 27 - }, "signature": [ { "pluginId": "data", @@ -4973,60 +5603,68 @@ "text": "IFieldSubType" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 27 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 28 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.customLabel", "type": "string", + "tags": [], "label": "customLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 29 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.format", "type": "Any", + "tags": [], "label": "format", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", "lineNumber": 30 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IFieldType.toSpec", "type": "Function", + "tags": [], "label": "toSpec", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "lineNumber": 31 - }, "signature": [ "((options?: { getFormatterForField?: ((field: ", { @@ -5068,34 +5706,38 @@ "section": "def-common.FieldSpec", "text": "FieldSpec" } - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 31 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IIndexPattern", "type": "Interface", + "tags": [], "label": "IIndexPattern", "description": [ "\nIIndexPattern allows for an IndexPattern OR an index pattern saved object\ntoo ambiguous, should be avoided" ], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IIndexPattern.fields", "type": "Array", + "tags": [], "label": "fields", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 32 - }, "signature": [ { "pluginId": "data", @@ -5105,67 +5747,83 @@ "text": "IFieldType" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 32 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IIndexPattern.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IIndexPattern.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 34 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IIndexPattern.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nType is used for identifying rollup indices, otherwise left undefined" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 38 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IIndexPattern.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 39 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.IIndexPattern.getTimeField", "type": "Function", + "tags": [], "label": "getTimeField", + "description": [], "signature": [ "(() => ", { @@ -5177,25 +5835,21 @@ }, " | undefined) | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 40 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IIndexPattern.fieldFormatMap", "type": "Object", + "tags": [], "label": "fieldFormatMap", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 41 - }, "signature": [ "Record | undefined> | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 41 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IIndexPattern.getFormatterForField", "type": "Function", + "tags": [], "label": "getFormatterForField", "description": [ "\nLook up a formatter for a given field" ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 45 - }, "signature": [ "((field: ", { @@ -5254,19 +5910,23 @@ "text": "FieldFormat" }, ") | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 45 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList", "type": "Interface", + "tags": [], "label": "IIndexPatternFieldList", + "description": [], "signature": [ { "pluginId": "data", @@ -5285,13 +5945,19 @@ }, "[]" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.add", "type": "Function", + "tags": [], "label": "add", + "description": [], "signature": [ "(field: ", { @@ -5303,13 +5969,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.add.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5319,24 +5991,23 @@ "text": "FieldSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 18 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.getAll", "type": "Function", + "tags": [], "label": "getAll", + "description": [], "signature": [ "() => ", { @@ -5348,19 +6019,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.getByName", "type": "Function", + "tags": [], "label": "getByName", + "description": [], "signature": [ "(name: string) => ", { @@ -5372,34 +6045,39 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.getByName.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 20 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.getByType", "type": "Function", + "tags": [], "label": "getByType", + "description": [], "signature": [ "(type: string) => ", { @@ -5411,34 +6089,39 @@ }, "[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.getByType.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 21 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.remove", "type": "Function", + "tags": [], "label": "remove", + "description": [], "signature": [ "(field: ", { @@ -5450,13 +6133,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.remove.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5466,40 +6155,41 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 22 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.removeAll", "type": "Function", + "tags": [], "label": "removeAll", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.replaceAll", "type": "Function", + "tags": [], "label": "replaceAll", + "description": [], "signature": [ "(specs: ", { @@ -5511,13 +6201,19 @@ }, "[]) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.replaceAll.$1", "type": "Array", + "tags": [], "label": "specs", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5528,24 +6224,23 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 24 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.update", "type": "Function", + "tags": [], "label": "update", + "description": [], "signature": [ "(field: ", { @@ -5557,13 +6252,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.update.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5573,24 +6274,23 @@ "text": "FieldSpec" } ], - "description": [], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 25 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.toSpec", "type": "Function", + "tags": [], "label": "toSpec", + "description": [], "signature": [ "(options?: { getFormatterForField?: ((field: ", { @@ -5633,25 +6333,32 @@ "text": "FieldSpec" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.toSpec.$1.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IIndexPatternFieldList.toSpec.$1.options.getFormatterForField", "type": "Function", + "tags": [], "label": "getFormatterForField", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 27 - }, "signature": [ "((field: ", { @@ -5686,46 +6393,41 @@ "text": "FieldFormat" }, ") | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 27 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 26 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 26 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IIndexPatternsApiClient", "type": "Interface", + "tags": [], "label": "IIndexPatternsApiClient", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 134 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IIndexPatternsApiClient.getFieldsForTimePattern", "type": "Function", + "tags": [], "label": "getFieldsForTimePattern", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 135 - }, "signature": [ "(options: ", { @@ -5736,18 +6438,20 @@ "text": "GetFieldsOptionsTimePattern" }, ") => Promise" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 135 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IIndexPatternsApiClient.getFieldsForWildcard", "type": "Function", + "tags": [], "label": "getFieldsForWildcard", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 136 - }, "signature": [ "(options: ", { @@ -5758,206 +6462,236 @@ "text": "GetFieldsOptions" }, ") => Promise" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 136 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 134 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes", "type": "Interface", + "tags": [], "label": "IndexPatternAttributes", "description": [ "\nInterface for an index pattern saved object" ], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 54 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.fields", "type": "string", + "tags": [], "label": "fields", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 56 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.typeMeta", "type": "string", + "tags": [], "label": "typeMeta", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 58 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.intervalName", "type": "string", + "tags": [], "label": "intervalName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 59 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.sourceFilters", "type": "string", + "tags": [], "label": "sourceFilters", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 60 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.fieldFormatMap", "type": "string", + "tags": [], "label": "fieldFormatMap", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 61 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.fieldAttrs", "type": "string", + "tags": [], "label": "fieldAttrs", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 62 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.runtimeFieldMap", "type": "string", + "tags": [], "label": "runtimeFieldMap", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 63 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternAttributes.allowNoIndex", "type": "CompoundType", + "tags": [], "label": "allowNoIndex", "description": [ "\nprevents errors when index pattern exists before indices" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 67 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternExpressionType", "type": "Interface", + "tags": [], "label": "IndexPatternExpressionType", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternExpressionType.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"index_pattern\"" + ], "source": { "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", "lineNumber": 19 }, - "signature": [ - "\"index_pattern\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternExpressionType.value", "type": "Object", + "tags": [], "label": "value", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", - "lineNumber": 20 - }, "signature": [ { "pluginId": "data", @@ -5966,110 +6700,125 @@ "section": "def-common.IndexPatternSpec", "text": "IndexPatternSpec" } - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 20 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternSpec", "type": "Interface", + "tags": [], "label": "IndexPatternSpec", "description": [ "\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state" ], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 224 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nsaved object id" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 228 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.version", "type": "string", + "tags": [], "label": "version", "description": [ "\nsaved object version string" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 232 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.title", "type": "string", + "tags": [], "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 233 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.IndexPatternSpec.intervalName", + "type": "string", "tags": [ "deprecated" ], - "id": "def-common.IndexPatternSpec.intervalName", - "type": "string", "label": "intervalName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 238 }, - "signature": [ - "string | undefined" - ] + "deprecated": true, + "references": [] }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.timeFieldName", "type": "string", + "tags": [], "label": "timeFieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 239 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.sourceFilters", "type": "Array", + "tags": [], "label": "sourceFilters", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 240 - }, "signature": [ { "pluginId": "data", @@ -6079,18 +6828,20 @@ "text": "SourceFilter" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 240 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.fields", "type": "Object", + "tags": [], "label": "fields", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 241 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 241 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.typeMeta", "type": "Object", + "tags": [], "label": "typeMeta", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 242 - }, "signature": [ { "pluginId": "data", @@ -6122,32 +6875,36 @@ "text": "TypeMeta" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 242 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 243 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.fieldFormats", "type": "Object", + "tags": [], "label": "fieldFormats", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 244 - }, "signature": [ "Record>> | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 244 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.runtimeFieldMap", "type": "Object", + "tags": [], "label": "runtimeFieldMap", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 245 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 245 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.fieldAttrs", "type": "Object", + "tags": [], "label": "fieldAttrs", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 246 - }, "signature": [ { "pluginId": "data", @@ -6201,88 +6962,100 @@ "text": "FieldAttrs" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 246 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IndexPatternSpec.allowNoIndex", "type": "CompoundType", + "tags": [], "label": "allowNoIndex", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 247 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 224 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.RuntimeField", "type": "Interface", + "tags": [], "label": "RuntimeField", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.RuntimeField.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\"" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 21 }, - "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RuntimeField.script", "type": "Object", + "tags": [], "label": "script", "description": [], + "signature": [ + "{ source: string; } | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 22 }, - "signature": [ - "{ source: string; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommon", "type": "Interface", + "tags": [], "label": "SavedObjectsClientCommon", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 101 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommon.find", "type": "Function", + "tags": [], "label": "find", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 102 - }, "signature": [ "(options: ", { @@ -6295,371 +7068,417 @@ ") => Promise<", "SavedObject", "[]>" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 102 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommon.get", "type": "Function", + "tags": [], "label": "get", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 103 - }, "signature": [ "(type: string, id: string) => Promise<", "SavedObject", ">" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 103 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommon.update", "type": "Function", + "tags": [], "label": "update", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 104 - }, "signature": [ "(type: string, id: string, attributes: Record, options: Record) => Promise<", "SavedObject", ">" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 104 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommon.create", "type": "Function", + "tags": [], "label": "create", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 110 - }, "signature": [ "(type: string, attributes: Record, options: Record) => Promise<", "SavedObject", ">" - ] + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 110 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommon.delete", "type": "Function", + "tags": [], "label": "delete", "description": [], + "signature": [ + "(type: string, id: string) => Promise<{}>" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 115 }, - "signature": [ - "(type: string, id: string) => Promise<{}>" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 101 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommonFindArgs", "type": "Interface", + "tags": [], "label": "SavedObjectsClientCommonFindArgs", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 93 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommonFindArgs.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 94 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommonFindArgs.fields", "type": "Array", + "tags": [], "label": "fields", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 95 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommonFindArgs.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 96 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommonFindArgs.search", "type": "string", + "tags": [], "label": "search", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 97 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SavedObjectsClientCommonFindArgs.searchFields", "type": "Array", + "tags": [], "label": "searchFields", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 98 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 93 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SourceFilter", "type": "Interface", + "tags": [], "label": "SourceFilter", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 250 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SourceFilter.value", "type": "string", + "tags": [], "label": "value", "description": [], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 251 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 250 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.TypeMeta", "type": "Interface", + "tags": [], "label": "TypeMeta", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 158 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.TypeMeta.aggs", "type": "Object", + "tags": [], "label": "aggs", "description": [], + "signature": [ + "Record> | undefined" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 159 }, - "signature": [ - "Record> | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.TypeMeta.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 160 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 158 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.UiSettingsCommon", "type": "Interface", + "tags": [], "label": "UiSettingsCommon", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.UiSettingsCommon.get", "type": "Function", + "tags": [], "label": "get", "description": [], + "signature": [ + "(key: string) => Promise" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 87 }, - "signature": [ - "(key: string) => Promise" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.UiSettingsCommon.getAll", "type": "Function", + "tags": [], "label": "getAll", "description": [], + "signature": [ + "() => Promise>" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 88 }, - "signature": [ - "() => Promise>" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.UiSettingsCommon.set", "type": "Function", + "tags": [], "label": "set", "description": [], + "signature": [ + "(key: string, value: any) => Promise" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 89 }, - "signature": [ - "(key: string, value: any) => Promise" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.UiSettingsCommon.remove", "type": "Function", + "tags": [], "label": "remove", "description": [], + "signature": [ + "(key: string) => Promise" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 90 }, - "signature": [ - "(key: string) => Promise" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 86 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "data", "id": "def-common.AggregationRestrictions", "type": "Type", - "label": "AggregationRestrictions", "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; }; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 141 }, - "signature": [ - "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldFormatMap", "type": "Type", - "label": "FieldFormatMap", "tags": [], + "label": "FieldFormatMap", "description": [], + "signature": [ + "{ [x: string]: SerializedFieldFormat>; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 17 }, - "signature": [ - "{ [x: string]: SerializedFieldFormat>; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldSpecConflictDescriptions", "type": "Type", - "label": "FieldSpecConflictDescriptions", "tags": [], + "label": "FieldSpecConflictDescriptions", "description": [], + "signature": [ + "{ [x: string]: string[]; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 163 }, - "signature": [ - "{ [x: string]: string[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternFieldMap", "type": "Type", - "label": "IndexPatternFieldMap", "tags": [], + "label": "IndexPatternFieldMap", "description": [], + "signature": [ + "{ [x: string]: FieldSpec; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 218 }, - "signature": [ - "{ [x: string]: FieldSpec; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternLoadExpressionFunctionDefinition", "type": "Type", - "label": "IndexPatternLoadExpressionFunctionDefinition", "tags": [], + "label": "IndexPatternLoadExpressionFunctionDefinition", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", - "lineNumber": 35 - }, "signature": [ "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", { @@ -6681,33 +7500,37 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 35 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IndexPatternsContract", "type": "Type", - "label": "IndexPatternsContract", "tags": [], + "label": "IndexPatternsContract", "description": [], + "signature": [ + "{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; find: (search: string, size?: number) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise[] | null | undefined>; getDefault: () => Promise; setDefault: (id: string, force?: boolean) => Promise; getFieldsForWildcard: (options: GetFieldsOptions) => Promise; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise; refreshFields: (indexPattern: IndexPattern) => Promise; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record; savedObjectToSpec: (savedObject: SavedObject) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" + ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 642 }, - "signature": [ - "{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; find: (search: string, size?: number) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise[] | null | undefined>; getDefault: () => Promise; setDefault: (id: string, force?: boolean) => Promise; getFieldsForWildcard: (options: GetFieldsOptions) => Promise; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise; refreshFields: (indexPattern: IndexPattern) => Promise; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record; savedObjectToSpec: (savedObject: SavedObject) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.OnError", "type": "Type", - "label": "OnError", "tags": [], + "label": "OnError", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 84 - }, "signature": [ "(error: Error, toastInputFields: ", { @@ -6719,18 +7542,20 @@ }, ") => void" ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 84 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.OnNotification", "type": "Type", - "label": "OnNotification", "tags": [], + "label": "OnNotification", "description": [], - "source": { - "path": "src/plugins/data/common/index_patterns/types.ts", - "lineNumber": 83 - }, "signature": [ "(toastInputFields: ", { @@ -6742,38 +7567,47 @@ }, ") => void" ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 83 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.RuntimeType", "type": "Type", - "label": "RuntimeType", "tags": [], + "label": "RuntimeType", "description": [], + "signature": [ + "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\"" + ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 19 }, - "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.RUNTIME_FIELD_TYPES", "type": "Object", + "tags": [], "label": "RUNTIME_FIELD_TYPES", "description": [], + "signature": [ + "readonly [\"keyword\", \"long\", \"double\", \"date\", \"ip\", \"boolean\"]" + ], "source": { "path": "src/plugins/data/common/index_patterns/constants.ts", "lineNumber": 9 }, - "signature": [ - "readonly [\"keyword\", \"long\", \"double\", \"date\", \"ip\", \"boolean\"]" - ], + "deprecated": false, "initialIsOpen": false } ] diff --git a/api_docs/data_query.json b/api_docs/data_query.json index b9fa69bd66b22..c8fff2616931e 100644 --- a/api_docs/data_query.json +++ b/api_docs/data_query.json @@ -3,26 +3,41 @@ "client": { "classes": [ { + "parentPluginId": "data", "id": "def-public.FilterManager", "type": "Class", "tags": [], "label": "FilterManager", "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FilterManager.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FilterManager.Unnamed.$1", "type": "Object", + "tags": [], "label": "uiSettings", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -32,24 +47,23 @@ "text": "IUiSettingsClient" } ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", - "lineNumber": 35 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.getFilters", "type": "Function", + "tags": [], "label": "getFilters", + "description": [], "signature": [ "() => ", { @@ -61,19 +75,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 92 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.getAppFilters", "type": "Function", + "tags": [], "label": "getAppFilters", + "description": [], "signature": [ "() => ", { @@ -85,19 +101,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 96 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.getGlobalFilters", "type": "Function", + "tags": [], "label": "getGlobalFilters", + "description": [], "signature": [ "() => ", { @@ -109,72 +127,80 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 101 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.getPartitionedFilters", "type": "Function", + "tags": [], "label": "getPartitionedFilters", + "description": [], "signature": [ "() => ", "PartitionedFilters" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 106 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.getUpdates$", "type": "Function", + "tags": [], "label": "getUpdates$", + "description": [], "signature": [ "() => ", "Observable", "" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 110 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.getFetches$", "type": "Function", + "tags": [], "label": "getFetches$", + "description": [], "signature": [ "() => ", "Observable", "" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 114 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.addFilters", "type": "Function", + "tags": [], "label": "addFilters", + "description": [], "signature": [ "(filters: ", { @@ -194,13 +220,19 @@ }, "[], pinFilterStatus?: boolean) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 120 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FilterManager.addFilters.$1", "type": "CompoundType", + "tags": [], "label": "filters", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -219,38 +251,40 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 121 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.FilterManager.addFilters.$2", "type": "boolean", + "tags": [], "label": "pinFilterStatus", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 122 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", - "lineNumber": 120 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.setFilters", "type": "Function", + "tags": [], "label": "setFilters", + "description": [], "signature": [ "(newFilters: ", { @@ -262,13 +296,19 @@ }, "[], pinFilterStatus?: boolean) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 148 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FilterManager.setFilters.$1", "type": "Array", + "tags": [], "label": "newFilters", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -279,38 +319,42 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 149 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.FilterManager.setFilters.$2", "type": "boolean", + "tags": [], "label": "pinFilterStatus", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 150 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", - "lineNumber": 148 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.setGlobalFilters", "type": "Function", + "tags": [], "label": "setGlobalFilters", + "description": [ + "\nSets new global filters and leaves app filters untouched,\nRemoves app filters for which there is a duplicate within new global filters" + ], "signature": [ "(newGlobalFilters: ", { @@ -322,15 +366,19 @@ }, "[]) => void" ], - "description": [ - "\nSets new global filters and leaves app filters untouched,\nRemoves app filters for which there is a duplicate within new global filters" - ], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 167 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FilterManager.setGlobalFilters.$1", "type": "Array", + "tags": [], "label": "newGlobalFilters", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -341,24 +389,25 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 167 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", - "lineNumber": 167 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.setAppFilters", "type": "Function", + "tags": [], "label": "setAppFilters", + "description": [ + "\nSets new app filters and leaves global filters untouched,\nRemoves app filters for which there is a duplicate within new global filters" + ], "signature": [ "(newAppFilters: ", { @@ -370,15 +419,19 @@ }, "[]) => void" ], - "description": [ - "\nSets new app filters and leaves global filters untouched,\nRemoves app filters for which there is a duplicate within new global filters" - ], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 184 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FilterManager.setAppFilters.$1", "type": "Array", + "tags": [], "label": "newAppFilters", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -389,24 +442,23 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 184 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", - "lineNumber": 184 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.removeFilter", "type": "Function", + "tags": [], "label": "removeFilter", + "description": [], "signature": [ "(filter: ", { @@ -418,13 +470,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 195 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FilterManager.removeFilter.$1", "type": "Object", + "tags": [], "label": "filter", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -434,40 +492,41 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 195 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", - "lineNumber": 195 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.removeAll", "type": "Function", + "tags": [], "label": "removeAll", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 207 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.FilterManager.setFiltersStore", "type": "Function", + "tags": [], "label": "setFiltersStore", + "description": [], "signature": [ "typeof ", { @@ -479,13 +538,19 @@ }, ".setFiltersStore" ], - "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 211 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.FilterManager.setFiltersStore.$1", "type": "Array", + "tags": [], "label": "filters", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -496,17 +561,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 212 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.FilterManager.setFiltersStore.$2", "type": "Enum", + "tags": [], "label": "store", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -516,62 +584,72 @@ "text": "FilterStateStore" } ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 213 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.FilterManager.setFiltersStore.$3", "type": "boolean", + "tags": [], "label": "shouldOverrideStore", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "lineNumber": 214 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", - "lineNumber": 211 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.TimeHistory", "type": "Class", "tags": [], "label": "TimeHistory", "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.TimeHistory.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.TimeHistory.Unnamed.$1", "type": "Object", + "tags": [], "label": "storage", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -582,24 +660,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/data/public/query/timefilter/time_history.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/query/timefilter/time_history.ts", - "lineNumber": 18 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.TimeHistory.add", "type": "Function", + "tags": [], "label": "add", + "description": [], "signature": [ "(time: ", { @@ -611,13 +688,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.TimeHistory.add.$1", "type": "Object", + "tags": [], "label": "time", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -627,24 +710,23 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/public/query/timefilter/time_history.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/query/timefilter/time_history.ts", - "lineNumber": 29 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.TimeHistory.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "() => ", { @@ -656,47 +738,91 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/public/query/timefilter/time_history.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/public/query/timefilter/time_history.ts", - "lineNumber": 15 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "data", "id": "def-public.connectToQueryState", "type": "Function", - "children": [ + "tags": [], + "label": "connectToQueryState", + "description": [ + "\nHelper to setup two-way syncing of global data and a state container" + ], + "signature": [ + " void; filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryState", + "text": "QueryState" + }, + ">({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<{ addToQueryLog: (appName: string, { language, query }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + ") => void; filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; queryString: Pick<", + "QueryStringManager", + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQueryService", + "text": "SavedQueryService" + } + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "lineNumber": 23 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.connectToQueryState.$1", + "type": "Object", + "tags": [], + "label": "{\n timefilter: { timefilter },\n filterManager,\n queryString,\n state$,\n }", + "description": [], + "signature": [ + "Pick<{ addToQueryLog: (appName: string, { language, query }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + ") => void; filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" }, @@ -713,17 +839,20 @@ "; state$: ", "Observable" ], - "description": [], "source": { "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.connectToQueryState.$2", "type": "Object", + "tags": [], "label": "stateContainer", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -734,57 +863,65 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.connectToQueryState.$3.syncConfig", "type": "Object", - "label": "syncConfig", "tags": [], + "label": "syncConfig", "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.connectToQueryState.$3.syncConfig.time", "type": "CompoundType", + "tags": [], "label": "time", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "lineNumber": 32 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.connectToQueryState.$3.syncConfig.refreshInterval", "type": "CompoundType", + "tags": [], "label": "refreshInterval", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "lineNumber": 33 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.connectToQueryState.$3.syncConfig.filters", "type": "CompoundType", + "tags": [], "label": "filters", "description": [], - "source": { - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", - "lineNumber": 34 - }, "signature": [ "boolean | ", { @@ -795,57 +932,52 @@ "text": "FilterStateStore" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "lineNumber": 34 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.connectToQueryState.$3.syncConfig.query", "type": "CompoundType", + "tags": [], "label": "query", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "lineNumber": 35 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", - "lineNumber": 31 - } + ] } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.createSavedQueryService", + "type": "Function", + "tags": [], + "label": "createSavedQueryService", + "description": [], "signature": [ - "({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<{ addToQueryLog: (appName: string, { language, query }: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - }, - ") => void; filterManager: ", + "(savedObjectsClient: Pick<", { - "pluginId": "data", + "pluginId": "core", "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsClient", + "text": "SavedObjectsClient" }, - "; queryString: Pick<", - "QueryStringManager", - ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">) => ", { "pluginId": "data", "scope": "public", @@ -854,27 +986,19 @@ "text": "SavedQueryService" } ], - "description": [ - "\nHelper to setup two-way syncing of global data and a state container" - ], - "label": "connectToQueryState", "source": { - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", - "lineNumber": 23 + "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", + "lineNumber": 21 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.createSavedQueryService", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.createSavedQueryService.$1", "type": "Object", + "tags": [], "label": "savedObjectsClient", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -886,45 +1010,24 @@ }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">" ], - "description": [], "source": { "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", - "lineNumber": 21 - } - } - ], - "signature": [ - "(savedObjectsClient: Pick<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">) => ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQueryService", - "text": "SavedQueryService" + "lineNumber": 22 + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "createSavedQueryService", - "source": { - "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", - "lineNumber": 20 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.getDefaultQuery", "type": "Function", + "tags": [], "label": "getDefaultQuery", + "description": [], "signature": [ "(language: ", "QueryLanguage", @@ -932,40 +1035,85 @@ "QueryLanguage", "; }" ], - "description": [], + "source": { + "path": "src/plugins/data/public/query/lib/get_default_query.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.getDefaultQuery.$1", "type": "CompoundType", + "tags": [], "label": "language", - "isRequired": true, + "description": [], "signature": [ "QueryLanguage" ], - "description": [], "source": { "path": "src/plugins/data/public/query/lib/get_default_query.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/public/query/lib/get_default_query.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.syncQueryStateWithUrl", "type": "Function", + "tags": [], + "label": "syncQueryStateWithUrl", + "description": [ + "\nHelper to setup syncing of global data with the URL" + ], + "signature": [ + "(query: Pick<{ addToQueryLog: (appName: string, { language, query }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + ") => void; filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; queryString: Pick<", + "QueryStringManager", + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQueryService", + "text": "SavedQueryService" + }, + "; state$: ", + "Observable" + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.syncQueryStateWithUrl.$1", "type": "Object", + "tags": [], "label": "query", - "isRequired": true, + "description": [], "signature": [ "Pick<{ addToQueryLog: (appName: string, { language, query }: ", { @@ -996,17 +1144,20 @@ "; state$: ", "Observable" ], - "description": [], "source": { "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.syncQueryStateWithUrl.$2", "type": "Object", + "tags": [], "label": "kbnUrlStateStorage", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -1016,76 +1167,41 @@ "text": "IKbnUrlStateStorage" } ], - "description": [], "source": { "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(query: Pick<{ addToQueryLog: (appName: string, { language, query }: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - }, - ") => void; filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; queryString: Pick<", - "QueryStringManager", - ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQueryService", - "text": "SavedQueryService" - }, - "; state$: ", - "Observable" - ], - "description": [ - "\nHelper to setup syncing of global data with the URL" - ], - "label": "syncQueryStateWithUrl", - "source": { - "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", - "lineNumber": 26 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "data", "id": "def-public.QueryState", "type": "Interface", + "tags": [], "label": "QueryState", "description": [ "\nAll query state service state" ], - "tags": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryState.time", "type": "Object", + "tags": [], "label": "time", "description": [], - "source": { - "path": "src/plugins/data/public/query/state_sync/types.ts", - "lineNumber": 15 - }, "signature": [ { "pluginId": "data", @@ -1095,18 +1211,20 @@ "text": "TimeRange" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 15 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryState.refreshInterval", "type": "Object", + "tags": [], "label": "refreshInterval", "description": [], - "source": { - "path": "src/plugins/data/public/query/state_sync/types.ts", - "lineNumber": 16 - }, "signature": [ { "pluginId": "data", @@ -1116,18 +1234,20 @@ "text": "RefreshInterval" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 16 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryState.filters", "type": "Array", + "tags": [], "label": "filters", "description": [], - "source": { - "path": "src/plugins/data/public/query/state_sync/types.ts", - "lineNumber": 17 - }, "signature": [ { "pluginId": "data", @@ -1137,18 +1257,20 @@ "text": "Filter" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryState.query", "type": "Object", + "tags": [], "label": "query", "description": [], - "source": { - "path": "src/plugins/data/public/query/state_sync/types.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "data", @@ -1158,19 +1280,23 @@ "text": "Query" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 18 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/query/state_sync/types.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.QueryStateChange", "type": "Interface", + "tags": [], "label": "QueryStateChange", + "description": [], "signature": [ { "pluginId": "data", @@ -1181,100 +1307,112 @@ }, " extends QueryStateChangePartial" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStateChange.appFilters", "type": "CompoundType", + "tags": [], "label": "appFilters", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/query/state_sync/types.ts", "lineNumber": 26 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStateChange.globalFilters", "type": "CompoundType", + "tags": [], "label": "globalFilters", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/query/state_sync/types.ts", "lineNumber": 27 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/query/state_sync/types.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SavedQuery", "type": "Interface", + "tags": [], "label": "SavedQuery", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.SavedQuery.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SavedQuery.attributes", "type": "Object", + "tags": [], "label": "attributes", "description": [], + "signature": [ + "SavedQueryAttributes" + ], "source": { "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 17 }, - "signature": [ - "SavedQueryAttributes" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/query/saved_query/types.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SavedQueryService", "type": "Interface", + "tags": [], "label": "SavedQueryService", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.SavedQueryService.saveQuery", "type": "Function", + "tags": [], "label": "saveQuery", "description": [], - "source": { - "path": "src/plugins/data/public/query/saved_query/types.ts", - "lineNumber": 29 - }, "signature": [ "(attributes: ", "SavedQueryAttributes", @@ -1287,18 +1425,20 @@ "text": "SavedQuery" }, ">" - ] + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SavedQueryService.getAllSavedQueries", "type": "Function", + "tags": [], "label": "getAllSavedQueries", "description": [], - "source": { - "path": "src/plugins/data/public/query/saved_query/types.ts", - "lineNumber": 33 - }, "signature": [ "() => Promise<", { @@ -1309,18 +1449,20 @@ "text": "SavedQuery" }, "[]>" - ] + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SavedQueryService.findSavedQueries", "type": "Function", + "tags": [], "label": "findSavedQueries", "description": [], - "source": { - "path": "src/plugins/data/public/query/saved_query/types.ts", - "lineNumber": 34 - }, "signature": [ "(searchText?: string | undefined, perPage?: number | undefined, activePage?: number | undefined) => Promise<{ total: number; queries: ", { @@ -1331,18 +1473,20 @@ "text": "SavedQuery" }, "[]; }>" - ] + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 34 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SavedQueryService.getSavedQuery", "type": "Function", + "tags": [], "label": "getSavedQuery", "description": [], - "source": { - "path": "src/plugins/data/public/query/saved_query/types.ts", - "lineNumber": 39 - }, "signature": [ "(id: string) => Promise<", { @@ -1353,71 +1497,75 @@ "text": "SavedQuery" }, ">" - ] + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 39 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SavedQueryService.deleteSavedQuery", "type": "Function", + "tags": [], "label": "deleteSavedQuery", "description": [], + "signature": [ + "(id: string) => Promise<{}>" + ], "source": { "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 40 }, - "signature": [ - "(id: string) => Promise<{}>" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SavedQueryService.getSavedQueryCount", "type": "Function", + "tags": [], "label": "getSavedQueryCount", "description": [], + "signature": [ + "() => Promise" + ], "source": { "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 41 }, - "signature": [ - "() => Promise" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/query/saved_query/types.ts", - "lineNumber": 28 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "data", "id": "def-public.AutoRefreshDoneFn", "type": "Type", - "label": "AutoRefreshDoneFn", "tags": [], + "label": "AutoRefreshDoneFn", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/data/public/query/timefilter/lib/auto_refresh_loop.ts", "lineNumber": 13 }, - "signature": [ - "() => void" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.InputTimeRange", "type": "Type", - "label": "InputTimeRange", "tags": [], + "label": "InputTimeRange", "description": [], - "source": { - "path": "src/plugins/data/public/query/timefilter/types.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "data", @@ -1428,18 +1576,20 @@ }, " | { from: moment.Moment; to: moment.Moment; }" ], + "source": { + "path": "src/plugins/data/public/query/timefilter/types.ts", + "lineNumber": 19 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.QueryStart", "type": "Type", - "label": "QueryStart", "tags": [], + "label": "QueryStart", "description": [], - "source": { - "path": "src/plugins/data/public/query/query_service.ts", - "lineNumber": 103 - }, "signature": [ "{ addToQueryLog: (appName: string, { language, query }: ", { @@ -1476,33 +1626,37 @@ "text": "QueryState" } ], + "source": { + "path": "src/plugins/data/public/query/query_service.ts", + "lineNumber": 103 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SavedQueryTimeFilter", "type": "Type", - "label": "SavedQueryTimeFilter", "tags": [], + "label": "SavedQueryTimeFilter", "description": [], + "signature": [ + "TimeRange & { refreshInterval: RefreshInterval; }" + ], "source": { "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 11 }, - "signature": [ - "TimeRange & { refreshInterval: RefreshInterval; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.TimefilterContract", "type": "Type", - "label": "TimefilterContract", "tags": [], + "label": "TimefilterContract", "description": [], - "source": { - "path": "src/plugins/data/public/query/timefilter/timefilter.ts", - "lineNumber": 242 - }, "signature": [ "{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; getEnabledUpdated$: () => ", "Observable", @@ -1515,21 +1669,28 @@ "; getFetch$: () => ", "Observable" ], + "source": { + "path": "src/plugins/data/public/query/timefilter/timefilter.ts", + "lineNumber": 242 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.TimeHistoryContract", "type": "Type", - "label": "TimeHistoryContract", "tags": [], + "label": "TimeHistoryContract", "description": [], + "signature": [ + "{ add: (time: TimeRange) => void; get: () => TimeRange[]; }" + ], "source": { "path": "src/plugins/data/public/query/timefilter/time_history.ts", "lineNumber": 47 }, - "signature": [ - "{ add: (time: TimeRange) => void; get: () => TimeRange[]; }" - ], + "deprecated": false, "initialIsOpen": false } ], @@ -1547,9 +1708,12 @@ "classes": [], "functions": [ { + "parentPluginId": "data", "id": "def-common.calculateBounds", "type": "Function", + "tags": [], "label": "calculateBounds", + "description": [], "signature": [ "(timeRange: ", { @@ -1568,13 +1732,19 @@ "text": "TimeRangeBounds" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.calculateBounds.$1", "type": "Object", + "tags": [], "label": "timeRange", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1584,44 +1754,98 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.calculateBounds.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ "CalculateBoundsOptions" ], - "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.compareFilters", + "type": "Function", + "tags": [], + "label": "compareFilters", + "description": [ + "\nCompare two filters or filter arrays to see if they match.\nFor filter arrays, the assumption is they are sorted.\n" + ], + "signature": [ + "(first: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[], second: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[], comparatorOptions?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.FilterCompareOptions", + "text": "FilterCompareOptions" } ], - "tags": [], - "returnComment": [], "source": { - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "lineNumber": 16 + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 64 }, - "initialIsOpen": false - }, - { - "id": "def-common.compareFilters", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.compareFilters.$1", "type": "CompoundType", + "tags": [], "label": "first", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1640,17 +1864,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 65 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.compareFilters.$2", "type": "CompoundType", + "tags": [], "label": "second", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1669,17 +1896,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 66 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.compareFilters.$3", "type": "Object", + "tags": [], "label": "comparatorOptions", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1689,15 +1919,30 @@ "text": "FilterCompareOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 67 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "Filters are the same" + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.dedupFilters", + "type": "Function", + "tags": [], + "label": "dedupFilters", + "description": [ + "\nCombine 2 filter collections, removing duplicates\n" + ], "signature": [ - "(first: ", + "(existingFilters: ", { "pluginId": "data", "scope": "common", @@ -1705,7 +1950,7 @@ "section": "def-common.Filter", "text": "Filter" }, - " | ", + "[], filters: ", { "pluginId": "data", "scope": "common", @@ -1713,15 +1958,15 @@ "section": "def-common.Filter", "text": "Filter" }, - "[], second: ", + "[], comparatorOptions?: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "docId": "kibDataQueryPluginApi", + "section": "def-common.FilterCompareOptions", + "text": "FilterCompareOptions" }, - " | ", + ") => ", { "pluginId": "data", "scope": "common", @@ -1729,38 +1974,21 @@ "section": "def-common.Filter", "text": "Filter" }, - "[], comparatorOptions?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.FilterCompareOptions", - "text": "FilterCompareOptions" - } - ], - "description": [ - "\nCompare two filters or filter arrays to see if they match.\nFor filter arrays, the assumption is they are sorted.\n" + "[]" ], - "label": "compareFilters", "source": { - "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", - "lineNumber": 64 + "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", + "lineNumber": 22 }, - "tags": [], - "returnComment": [ - "Filters are the same" - ], - "initialIsOpen": false - }, - { - "id": "def-common.dedupFilters", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.dedupFilters.$1", "type": "Array", + "tags": [], "label": "existingFilters", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1771,17 +1999,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.dedupFilters.$2", "type": "Array", + "tags": [], "label": "filters", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1792,17 +2023,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.dedupFilters.$3", "type": "Object", + "tags": [], "label": "comparatorOptions", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1812,66 +2046,26 @@ "text": "FilterCompareOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(existingFilters: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[], filters: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[], comparatorOptions?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.FilterCompareOptions", - "text": "FilterCompareOptions" - }, - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]" - ], - "description": [ - "\nCombine 2 filter collections, removing duplicates\n" - ], - "label": "dedupFilters", - "source": { - "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", - "lineNumber": 22 - }, - "tags": [], "returnComment": [ "An array of filters that were not in existing" ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getAbsoluteTimeRange", "type": "Function", + "tags": [], "label": "getAbsoluteTimeRange", + "description": [], "signature": [ "(timeRange: ", { @@ -1890,13 +2084,19 @@ "text": "TimeRange" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getAbsoluteTimeRange.$1", "type": "Object", + "tags": [], "label": "timeRange", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1906,52 +2106,55 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.getAbsoluteTimeRange.$2.forceNow", "type": "Object", - "label": "{ forceNow }", "tags": [], + "label": "{ forceNow }", "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.getAbsoluteTimeRange.$2.forceNow.forceNow", "type": "Object", + "tags": [], "label": "forceNow", "description": [], + "signature": [ + "Date | undefined" + ], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 28 }, - "signature": [ - "Date | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "lineNumber": 28 - } + ] } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getTime", "type": "Function", + "tags": [], "label": "getTime", + "description": [], "signature": [ "(indexPattern: ", { @@ -1979,13 +2182,19 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getTime.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -1996,17 +2205,20 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.getTime.$2", "type": "Object", + "tags": [], "label": "timeRange", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -2016,149 +2228,193 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.getTime.$3.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.getTime.$3.options.forceNow", "type": "Object", + "tags": [], "label": "forceNow", "description": [], + "signature": [ + "Date | undefined" + ], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 40 }, - "signature": [ - "Date | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.getTime.$3.options.fieldName", "type": "string", + "tags": [], "label": "fieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/query/timefilter/get_time.ts", "lineNumber": 40 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "lineNumber": 40 - } + ] } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "lineNumber": 37 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isQuery", "type": "Function", + "tags": [], + "label": "isQuery", + "description": [], + "signature": [ + "(x: unknown) => x is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } + ], + "source": { + "path": "src/plugins/data/common/query/is_query.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isQuery.$1", "type": "Unknown", + "tags": [], "label": "x", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/data/common/query/is_query.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isTimeRange", + "type": "Function", + "tags": [], + "label": "isTimeRange", + "description": [], "signature": [ "(x: unknown) => x is ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-common.Query", - "text": "Query" + "section": "def-common.TimeRange", + "text": "TimeRange" } ], - "description": [], - "label": "isQuery", "source": { - "path": "src/plugins/data/common/query/is_query.ts", + "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", "lineNumber": 11 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isTimeRange", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isTimeRange.$1", "type": "Unknown", + "tags": [], "label": "x", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.uniqFilters", + "type": "Function", + "tags": [], + "label": "uniqFilters", + "description": [ + "\nRemove duplicate filters from an array of filters\n" + ], "signature": [ - "(x: unknown) => x is ", + "(filters: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[], comparatorOptions?: any) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" ], - "description": [], - "label": "isTimeRange", "source": { - "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", - "lineNumber": 11 + "path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts", + "lineNumber": 21 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.uniqFilters", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.uniqFilters.$1", "type": "Array", + "tags": [], "label": "filters", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -2169,55 +2425,31 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.uniqFilters.$2", "type": "Any", + "tags": [], "label": "comparatorOptions", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(filters: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[], comparatorOptions?: any) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]" - ], - "description": [ - "\nRemove duplicate filters from an array of filters\n" - ], - "label": "uniqFilters", - "source": { - "path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts", - "lineNumber": 21 - }, - "tags": [], "returnComment": [ "The original filters array with duplicates removed" ], @@ -2226,286 +2458,326 @@ ], "interfaces": [ { + "parentPluginId": "data", "id": "def-common.FilterCompareOptions", "type": "Interface", + "tags": [], "label": "FilterCompareOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FilterCompareOptions.index", "type": "CompoundType", + "tags": [], "label": "index", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 13 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FilterCompareOptions.disabled", "type": "CompoundType", + "tags": [], "label": "disabled", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 14 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FilterCompareOptions.negate", "type": "CompoundType", + "tags": [], "label": "negate", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 15 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FilterCompareOptions.state", "type": "CompoundType", + "tags": [], "label": "state", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 16 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FilterCompareOptions.alias", "type": "CompoundType", + "tags": [], "label": "alias", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 17 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.RefreshInterval", "type": "Interface", + "tags": [], "label": "RefreshInterval", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.RefreshInterval.pause", "type": "boolean", + "tags": [], "label": "pause", "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RefreshInterval.value", "type": "number", + "tags": [], "label": "value", "description": [], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 13 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/query/timefilter/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.TimeRangeBounds", "type": "Interface", + "tags": [], "label": "TimeRangeBounds", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.TimeRangeBounds.min", "type": "Object", + "tags": [], "label": "min", "description": [], + "signature": [ + "moment.Moment | undefined" + ], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 24 }, - "signature": [ - "moment.Moment | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.TimeRangeBounds.max", "type": "Object", + "tags": [], "label": "max", "description": [], + "signature": [ + "moment.Moment | undefined" + ], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 25 }, - "signature": [ - "moment.Moment | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/query/timefilter/types.ts", - "lineNumber": 23 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "data", "id": "def-common.Query", "type": "Type", - "label": "Query", "tags": [], + "label": "Query", "description": [], + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], "source": { "path": "src/plugins/data/common/query/types.ts", "lineNumber": 12 }, - "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.TimeRange", "type": "Type", - "label": "TimeRange", "tags": [], + "label": "TimeRange", "description": [], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], "source": { "path": "src/plugins/data/common/query/timefilter/types.ts", "lineNumber": 17 }, - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "data", "id": "def-common.COMPARE_ALL_OPTIONS", "type": "Object", "tags": [], + "label": "COMPARE_ALL_OPTIONS", + "description": [ + "\nInclude disabled, negate and store when comparing filters" + ], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.COMPARE_ALL_OPTIONS.index", "type": "boolean", + "tags": [], "label": "index", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 24 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.COMPARE_ALL_OPTIONS.disabled", "type": "boolean", + "tags": [], "label": "disabled", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 25 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.COMPARE_ALL_OPTIONS.negate", "type": "boolean", + "tags": [], "label": "negate", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 26 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.COMPARE_ALL_OPTIONS.state", "type": "boolean", + "tags": [], "label": "state", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 27 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.COMPARE_ALL_OPTIONS.alias", "type": "boolean", + "tags": [], "label": "alias", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", "lineNumber": 28 }, - "signature": [ - "true" - ] + "deprecated": false } ], - "description": [ - "\nInclude disabled, negate and store when comparing filters" - ], - "label": "COMPARE_ALL_OPTIONS", - "source": { - "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", - "lineNumber": 23 - }, "initialIsOpen": false } ] diff --git a/api_docs/data_search.json b/api_docs/data_search.json index b50d6d267d3f8..04f1aa5265a54 100644 --- a/api_docs/data_search.json +++ b/api_docs/data_search.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "data", "id": "def-public.PainlessError", "type": "Class", "tags": [], @@ -19,31 +20,35 @@ " extends ", "EsError" ], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.PainlessError.painlessStack", "type": "string", + "tags": [], "label": "painlessStack", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.PainlessError.indexPattern", "type": "Object", + "tags": [], "label": "indexPattern", "description": [], - "source": { - "path": "src/plugins/data/public/search/errors/painless_error.tsx", - "lineNumber": 21 - }, "signature": [ { "pluginId": "data", @@ -53,36 +58,59 @@ "text": "IndexPattern" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 21 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.PainlessError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.PainlessError.Unnamed.$1", "type": "Object", + "tags": [], "label": "err", - "isRequired": true, + "description": [], "signature": [ - "IEsError" + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.IEsError", + "text": "IEsError" + } ], - "description": [], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.PainlessError.Unnamed.$2", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -93,24 +121,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/errors/painless_error.tsx", - "lineNumber": 22 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.PainlessError.getErrorMessage", "type": "Function", + "tags": [], "label": "getErrorMessage", + "description": [], "signature": [ "(application: ", { @@ -122,13 +149,19 @@ }, ") => JSX.Element" ], - "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.PainlessError.getErrorMessage.$1", "type": "Object", + "tags": [], "label": "application", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -138,48 +171,55 @@ "text": "ApplicationStart" } ], - "description": [], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/errors/painless_error.tsx", - "lineNumber": 27 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/public/search/errors/painless_error.tsx", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SearchInterceptor", "type": "Class", "tags": [], "label": "SearchInterceptor", "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 67 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchInterceptor.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 93 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchInterceptor.Unnamed.$1", "type": "Object", + "tags": [], "label": "deps", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -189,153 +229,47 @@ "text": "SearchInterceptorDeps" } ], - "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 65 - } + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 93 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 65 - } + "returnComment": [] }, { - "id": "def-public.SearchInterceptor.getTimeoutMode", + "parentPluginId": "data", + "id": "def-public.SearchInterceptor.stop", "type": "Function", - "label": "getTimeoutMode", - "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.TimeoutErrorMode", - "text": "TimeoutErrorMode" - } - ], - "description": [], - "children": [], "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 81 - } - }, - { - "id": "def-public.SearchInterceptor.handleSearchError", - "type": "Function", - "label": "handleSearchError", - "signature": [ - "(e: ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.KibanaServerError", - "text": "KibanaServerError" - }, - " | ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.AbortError", - "text": "AbortError" - }, - ", options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined, isTimeout?: boolean | undefined) => Error" - ], + "label": "stop", "description": [], - "children": [ - { - "id": "def-public.SearchInterceptor.handleSearchError.$1", - "type": "CompoundType", - "label": "e", - "isRequired": true, - "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.KibanaServerError", - "text": "KibanaServerError" - }, - " | ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.AbortError", - "text": "AbortError" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 90 - } - }, - { - "id": "def-public.SearchInterceptor.handleSearchError.$2", - "type": "Object", - "label": "options", - "isRequired": false, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined" - ], - "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 91 - } - }, - { - "id": "def-public.SearchInterceptor.handleSearchError.$3", - "type": "CompoundType", - "label": "isTimeout", - "isRequired": false, - "signature": [ - "boolean | undefined" - ], - "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 92 - } - } + "signature": [ + "() => void" ], - "tags": [], - "returnComment": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 89 - } + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 113 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchInterceptor.search", "type": "Function", + "tags": [ + "options" + ], "label": "search", + "description": [ + "\nSearches using the given `search` method. Overrides the `AbortSignal` with one that will abort\neither when the request times out, or when the original `AbortSignal` is aborted. Updates\n`pendingCount$` when the request is started/finalized.\n" + ], "signature": [ - "(request: ", + "({ id, ...request }: ", { "pluginId": "data", "scope": "common", @@ -348,8 +282,8 @@ "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "section": "def-common.IAsyncSearchOptions", + "text": "IAsyncSearchOptions" }, ") => ", "Observable", @@ -363,15 +297,19 @@ }, ">" ], - "description": [ - "\nSearches using the given `search` method. Overrides the `AbortSignal` with one that will abort\neither when the request times out, or when the original `AbortSignal` is aborted. Updates\n`pendingCount$` when the request is started/finalized.\n" - ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 313 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchInterceptor.search.$1", "type": "Object", - "label": "request", - "isRequired": true, + "tags": [], + "label": "{ id, ...request }", + "description": [], "signature": [ { "pluginId": "data", @@ -382,83 +320,82 @@ }, "" ], - "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 183 - } + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 313 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.SearchInterceptor.search.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "section": "def-common.IAsyncSearchOptions", + "text": "IAsyncSearchOptions" } ], - "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 184 - } + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 313 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "options" - ], "returnComment": [ "`Observable` emitting the search response or an error." - ], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 182 - } + ] }, { + "parentPluginId": "data", "id": "def-public.SearchInterceptor.showError", "type": "Function", + "tags": [], "label": "showError", + "description": [], "signature": [ "(e: Error) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 386 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchInterceptor.showError.$1", "type": "Object", + "tags": [], "label": "e", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 207 - } + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 386 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 207 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 46 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SearchTimeoutError", "type": "Class", "tags": [], @@ -483,17 +420,19 @@ "text": "KbnError" } ], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchTimeoutError.mode", "type": "Enum", + "tags": [], "label": "mode", "description": [], - "source": { - "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 26 - }, "signature": [ { "pluginId": "data", @@ -502,36 +441,53 @@ "section": "def-public.TimeoutErrorMode", "text": "TimeoutErrorMode" } - ] + ], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 25 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-public.SearchTimeoutError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchTimeoutError.Unnamed.$1", "type": "Object", + "tags": [], "label": "err", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 27 - } + "lineNumber": 26 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.SearchTimeoutError.Unnamed.$2", "type": "Enum", + "tags": [], "label": "mode", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -541,24 +497,23 @@ "text": "TimeoutErrorMode" } ], - "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 27 - } + "lineNumber": 26 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 27 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchTimeoutError.getErrorMessage", "type": "Function", + "tags": [], "label": "getErrorMessage", + "description": [], "signature": [ "(application: ", { @@ -570,13 +525,19 @@ }, ") => JSX.Element" ], - "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 66 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.SearchTimeoutError.getErrorMessage.$1", "type": "Object", + "tags": [], "label": "application", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -586,33 +547,28 @@ "text": "ApplicationStart" } ], - "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 80 - } + "lineNumber": 66 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 80 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 25 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "data", "id": "def-public.getEsPreference", "type": "Function", + "tags": [], "label": "getEsPreference", + "description": [], "signature": [ "(uiSettings: ", { @@ -624,13 +580,19 @@ }, ", sessionId: string) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.getEsPreference.$1", "type": "Object", + "tags": [], "label": "uiSettings", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -640,39 +602,82 @@ "text": "IUiSettingsClient" } ], - "description": [], "source": { "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.getEsPreference.$2", "type": "string", + "tags": [], "label": "sessionId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.isEsError", + "type": "Function", + "tags": [], + "label": "isEsError", + "description": [ + "\nChecks if a given errors originated from Elasticsearch.\nThose params are assigned to the attributes property of an error.\n" + ], + "signature": [ + "(e: any) => boolean" + ], "source": { - "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", - "lineNumber": 14 + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 51 }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.isEsError.$1", + "type": "Any", + "tags": [], + "label": "e", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 51 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.waitUntilNextSessionCompletes$", "type": "Function", + "tags": [], "label": "waitUntilNextSessionCompletes$", + "description": [ + "\nCreates an observable that emits when next search session completes.\nThis utility is helpful to use in the application to delay some tasks until next session completes.\n" + ], "signature": [ "(sessionService: Pick<", "SessionService", @@ -696,33 +701,40 @@ }, ">" ], - "description": [ - "\nCreates an observable that emits when next search session completes.\nThis utility is helpful to use in the application to delay some tasks until next session completes.\n" - ], + "source": { + "path": "src/plugins/data/public/search/session/session_helpers.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.waitUntilNextSessionCompletes$.$1", "type": "Object", + "tags": [], "label": "sessionService", - "isRequired": true, + "description": [ + "- {@link ISessionService}" + ], "signature": [ "Pick<", "SessionService", ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" ], - "description": [ - "- {@link ISessionService}" - ], "source": { "path": "src/plugins/data/public/search/session/session_helpers.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.waitUntilNextSessionCompletes$.$2", "type": "Object", + "tags": [], "label": "{ waitForIdle = 1000 }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -732,127 +744,134 @@ "text": "WaitUntilNextSessionCompletesOptions" } ], - "description": [], "source": { "path": "src/plugins/data/public/search/session/session_helpers.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/session/session_helpers.ts", - "lineNumber": 30 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "data", "id": "def-public.ISearchSetup", "type": "Interface", + "tags": [], "label": "ISearchSetup", "description": [ "\nThe setup contract exposed by the Search plugin exposes the search strategy extension\npoint." ], - "tags": [], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchSetup.aggs", "type": "Object", + "tags": [], "label": "aggs", "description": [], + "signature": [ + "AggsCommonSetup" + ], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 29 + "lineNumber": 24 }, - "signature": [ - "AggsCommonSetup" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchSetup.usageCollector", "type": "Object", + "tags": [], "label": "usageCollector", "description": [], - "source": { - "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 30 - }, "signature": [ "SearchUsageCollector", " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 25 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchSetup.session", "type": "Object", + "tags": [], "label": "session", "description": [ "\nCurrent session management\n{@link ISessionService}" ], - "source": { - "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 35 - }, "signature": [ "Pick<", "SessionService", ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" - ] + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 30 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchSetup.sessionsClient", "type": "Object", + "tags": [], "label": "sessionsClient", "description": [ "\nSearch sessions SO CRUD\n{@link ISessionsClient}" ], - "source": { - "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 40 - }, "signature": [ "Pick<", "SessionsClient", ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"rename\" | \"extend\">" - ] + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 35 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ISearchStart", "type": "Interface", + "tags": [], "label": "ISearchStart", "description": [ "\nsearch service" ], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchStart.aggs", "type": "Object", + "tags": [], "label": "aggs", "description": [ "\nagg config sub service\n{@link AggsStart}\n" ], - "source": { - "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 57 - }, "signature": [ "Pick & Pick<{ types: ", "AggTypesRegistryStart", "; }, never>, \"calculateAutoTimeExpression\" | \"datatableUtilities\" | \"createAggConfigs\" | \"types\">" - ] + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 48 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchStart.search", "type": "Function", + "tags": [], "label": "search", "description": [ "\nlow level search\n{@link ISearchGeneric}" ], - "source": { - "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 62 - }, "signature": [ { "pluginId": "data", @@ -883,34 +904,38 @@ "section": "def-common.ISearchGeneric", "text": "ISearchGeneric" } - ] + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 53 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchStart.showError", "type": "Function", + "tags": [], "label": "showError", "description": [], + "signature": [ + "(e: Error) => void" + ], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 64 + "lineNumber": 55 }, - "signature": [ - "(e: Error) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchStart.searchSource", "type": "Object", + "tags": [], "label": "searchSource", "description": [ "\nhigh level search\n{@link ISearchStartSearchSource}" ], - "source": { - "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 69 - }, "signature": [ { "pluginId": "data", @@ -919,88 +944,220 @@ "section": "def-common.ISearchStartSearchSource", "text": "ISearchStartSearchSource" } - ] + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 60 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchStart.session", "type": "Object", + "tags": [], "label": "session", "description": [ "\nCurrent session management\n{@link ISessionService}" ], - "source": { - "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 74 - }, "signature": [ "Pick<", "SessionService", ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" - ] + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 65 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchStart.sessionsClient", "type": "Object", + "tags": [], "label": "sessionsClient", "description": [ "\nSearch sessions SO CRUD\n{@link ISessionsClient}" ], - "source": { - "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 79 - }, "signature": [ "Pick<", "SessionsClient", ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"rename\" | \"extend\">" - ] + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 70 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 51 - }, "initialIsOpen": false }, { - "id": "def-public.SearchInterceptorDeps", + "parentPluginId": "data", + "id": "def-public.Reason", "type": "Interface", - "label": "SearchInterceptorDeps", - "description": [], "tags": [], + "label": "Reason", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", + "id": "def-public.Reason.type", + "type": "string", "tags": [], - "id": "def-public.SearchInterceptorDeps.bfetch", - "type": "Object", - "label": "bfetch", + "label": "type", "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 37 + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 19 }, - "signature": [ - { - "pluginId": "bfetch", - "scope": "public", - "docId": "kibBfetchPluginApi", - "section": "def-public.BfetchPublicContract", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.Reason.reason", + "type": "string", + "tags": [], + "label": "reason", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 20 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.Reason.script_stack", + "type": "Array", + "tags": [], + "label": "script_stack", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 21 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.Reason.position", + "type": "Object", + "tags": [], + "label": "position", + "description": [], + "signature": [ + "{ offset: number; start: number; end: number; } | undefined" + ], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 22 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.Reason.lang", + "type": "string", + "tags": [], + "label": "lang", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 27 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.Reason.script", + "type": "string", + "tags": [], + "label": "script", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 28 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.Reason.caused_by", + "type": "Object", + "tags": [], + "label": "caused_by", + "description": [], + "signature": [ + "{ type: string; reason: string; } | undefined" + ], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchInterceptorDeps", + "type": "Interface", + "tags": [], + "label": "SearchInterceptorDeps", + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 54 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SearchInterceptorDeps.bfetch", + "type": "Object", + "tags": [], + "label": "bfetch", + "description": [], + "signature": [ + { + "pluginId": "bfetch", + "scope": "public", + "docId": "kibBfetchPluginApi", + "section": "def-public.BfetchPublicContract", "text": "BfetchPublicContract" } - ] + ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchInterceptorDeps.http", "type": "Object", + "tags": [], "label": "http", "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 38 - }, "signature": [ { "pluginId": "core", @@ -1009,18 +1166,20 @@ "section": "def-public.HttpSetup", "text": "HttpSetup" } - ] + ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchInterceptorDeps.uiSettings", "type": "Object", + "tags": [], "label": "uiSettings", "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 39 - }, "signature": [ { "pluginId": "core", @@ -1029,18 +1188,20 @@ "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" } - ] + ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 57 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchInterceptorDeps.startServices", "type": "Object", + "tags": [], "label": "startServices", "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 40 - }, "signature": [ "Promise<[", { @@ -1051,18 +1212,20 @@ "text": "CoreStart" }, ", any, unknown]>" - ] + ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 58 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchInterceptorDeps.toasts", "type": "Object", + "tags": [], "label": "toasts", "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 41 - }, "signature": [ "Pick<", { @@ -1073,50 +1236,60 @@ "text": "ToastsApi" }, ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" - ] + ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 59 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchInterceptorDeps.usageCollector", "type": "Object", + "tags": [], "label": "usageCollector", "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 42 - }, "signature": [ "SearchUsageCollector", " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 60 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchInterceptorDeps.session", "type": "Object", + "tags": [], "label": "session", "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 43 - }, "signature": [ "Pick<", "SessionService", ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" - ] + ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 61 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 36 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SearchSessionInfoProvider", "type": "Interface", + "tags": [], "label": "SearchSessionInfoProvider", + "description": [ + "\nProvide info about current search session to be stored in the Search Session saved object" + ], "signature": [ { "pluginId": "data", @@ -1127,53 +1300,55 @@ }, "" ], - "description": [ - "\nProvide info about current search session to be stored in the Search Session saved object" - ], - "tags": [], + "source": { + "path": "src/plugins/data/public/search/session/session_service.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSessionInfoProvider.getName", "type": "Function", + "tags": [], "label": "getName", "description": [ "\nUser-facing name of the session.\ne.g. will be displayed in saved Search Sessions management list" ], + "signature": [ + "() => Promise" + ], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 46 }, - "signature": [ - "() => Promise" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSessionInfoProvider.appendSessionStartTimeToName", "type": "CompoundType", + "tags": [], "label": "appendSessionStartTimeToName", "description": [ "\nAppend session start time to a session name,\n`true` by default" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 52 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchSessionInfoProvider.getUrlGeneratorData", "type": "Function", + "tags": [], "label": "getUrlGeneratorData", "description": [], - "source": { - "path": "src/plugins/data/public/search/session/session_service.ts", - "lineNumber": 54 - }, "signature": [ "() => Promise<{ urlGeneratorId: ID; initialState: ", { @@ -1192,56 +1367,60 @@ "text": "UrlGeneratorStateMapping" }, "[ID][\"State\"]; }>" - ] + ], + "source": { + "path": "src/plugins/data/public/search/session/session_service.ts", + "lineNumber": 54 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/search/session/session_service.ts", - "lineNumber": 41 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.WaitUntilNextSessionCompletesOptions", "type": "Interface", + "tags": [], "label": "WaitUntilNextSessionCompletesOptions", "description": [ "\nOptions for {@link waitUntilNextSessionCompletes$}" ], - "tags": [], + "source": { + "path": "src/plugins/data/public/search/session/session_helpers.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.WaitUntilNextSessionCompletesOptions.waitForIdle", "type": "number", + "tags": [], "label": "waitForIdle", "description": [ "\nFor how long to wait between session state transitions before considering that session completed" ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/public/search/session/session_helpers.ts", "lineNumber": 20 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/search/session/session_helpers.ts", - "lineNumber": 16 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "data", "id": "def-public.SearchSessionState", "type": "Enum", + "tags": [], "label": "SearchSessionState", - "tags": [ - "public" - ], "description": [ "\nPossible state that current session can be in\n" ], @@ -1249,56 +1428,81 @@ "path": "src/plugins/data/public/search/session/search_session_state.ts", "lineNumber": 21 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.TimeoutErrorMode", "type": "Enum", - "label": "TimeoutErrorMode", "tags": [], + "label": "TimeoutErrorMode", "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 15 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "data", + "id": "def-public.IEsError", + "type": "Type", + "tags": [], + "label": "IEsError", + "description": [], + "signature": [ + "KibanaServerError" + ], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 43 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", "id": "def-public.ISessionsClient", "type": "Type", - "label": "ISessionsClient", "tags": [], + "label": "ISessionsClient", "description": [], + "signature": [ + "{ get: (sessionId: string) => Promise; delete: (sessionId: string) => Promise; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record; restoreState: Record; urlGeneratorId: string; sessionId: string; }) => Promise; find: (options: Pick) => Promise>; update: (sessionId: string, attributes: unknown) => Promise>; rename: (sessionId: string, newName: string) => Promise>>; extend: (sessionId: string, expires: string) => Promise>; }" + ], "source": { "path": "src/plugins/data/public/search/session/sessions_client.ts", "lineNumber": 18 }, - "signature": [ - "{ get: (sessionId: string) => Promise; delete: (sessionId: string) => Promise; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record; restoreState: Record; urlGeneratorId: string; sessionId: string; }) => Promise; find: (options: Pick) => Promise>; update: (sessionId: string, attributes: unknown) => Promise>; rename: (sessionId: string, newName: string) => Promise>>; extend: (sessionId: string, expires: string) => Promise>; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.ISessionService", "type": "Type", - "label": "ISessionService", "tags": [], + "label": "ISessionService", "description": [], + "signature": [ + "{ start: () => string; destroy: () => void; readonly state$: Observable; readonly sessionMeta$: Observable; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => () => void; getSessionId: () => string | undefined; getSession$: () => Observable; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: SearchSessionInfoProvider, searchSessionIndicatorUiConfig?: SearchSessionIndicatorUiConfig | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => SearchSessionIndicatorUiConfig; }" + ], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 32 }, - "signature": [ - "{ start: () => string; destroy: () => void; readonly state$: Observable; readonly sessionMeta$: Observable; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => () => void; getSessionId: () => string | undefined; getSession$: () => Observable; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: SearchSessionInfoProvider, searchSessionIndicatorUiConfig?: SearchSessionIndicatorUiConfig | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => SearchSessionIndicatorUiConfig; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.noSearchSessionStorageCapabilityMessage", "type": "string", + "tags": [], "label": "noSearchSessionStorageCapabilityMessage", "description": [ "\nMessage to display in case storing\nsession session is disabled due to turned off capability" @@ -1307,21 +1511,24 @@ "path": "src/plugins/data/public/search/session/i18n.ts", "lineNumber": 15 }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SEARCH_SESSIONS_MANAGEMENT_ID", "type": "string", + "tags": [], "label": "SEARCH_SESSIONS_MANAGEMENT_ID", "description": [], + "signature": [ + "\"search_sessions\"" + ], "source": { "path": "src/plugins/data/public/search/session/constants.ts", "lineNumber": 9 }, - "signature": [ - "\"search_sessions\"" - ], + "deprecated": false, "initialIsOpen": false } ], @@ -1331,9 +1538,12 @@ "classes": [], "functions": [ { + "parentPluginId": "data", "id": "def-server.getDefaultSearchParams", "type": "Function", + "tags": [], "label": "getDefaultSearchParams", + "description": [], "signature": [ "(uiSettingsClient: ", { @@ -1349,13 +1559,19 @@ "RequestBody", ">>, \"max_concurrent_shard_requests\" | \"ignore_unavailable\" | \"track_total_hits\">>" ], - "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/es_search/request_utils.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.getDefaultSearchParams.$1", "type": "Object", + "tags": [], "label": "uiSettingsClient", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1365,25 +1581,24 @@ "text": "IUiSettingsClient" } ], - "description": [], "source": { - "path": "src/plugins/data/server/search/es_search/request_utils.ts", + "path": "src/plugins/data/server/search/strategies/es_search/request_utils.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/server/search/es_search/request_utils.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.getShardTimeout", "type": "Function", + "tags": [], "label": "getShardTimeout", + "description": [], "signature": [ "(config: Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly autocompleteTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", "ByteSizeValue", @@ -1396,13 +1611,19 @@ "<", "RequestBody" ], - "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/es_search/request_utils.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.getShardTimeout.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly autocompleteTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", "ByteSizeValue", @@ -1412,25 +1633,26 @@ "ByteSizeValue", ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>" ], - "description": [], "source": { - "path": "src/plugins/data/server/search/es_search/request_utils.ts", + "path": "src/plugins/data/server/search/strategies/es_search/request_utils.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/server/search/es_search/request_utils.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.searchUsageObserver", "type": "Function", + "tags": [], "label": "searchUsageObserver", + "description": [ + "\nRxjs observer for easily doing `tap(searchUsageObserver(logger, usage))` in an rxjs chain." + ], "signature": [ "(logger: ", "Logger", @@ -1460,29 +1682,36 @@ }, "): void; error(): void; }" ], - "description": [ - "\nRxjs observer for easily doing `tap(searchUsageObserver(logger, usage))` in an rxjs chain." - ], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 82 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.searchUsageObserver.$1", "type": "Object", + "tags": [], "label": "logger", - "isRequired": true, + "description": [], "signature": [ "Logger" ], - "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-server.searchUsageObserver.$2", "type": "Object", + "tags": [], "label": "usage", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -1493,17 +1722,20 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 84 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-server.searchUsageObserver.$3", "type": "Object", + "tags": [], "label": "{ isRestore }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1513,25 +1745,24 @@ "text": "ISearchOptions" } ], - "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 85 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/server/search/collectors/usage.ts", - "lineNumber": 82 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.usageProvider", "type": "Function", + "tags": [], "label": "usageProvider", + "description": [], "signature": [ "(core: ", { @@ -1550,13 +1781,19 @@ "text": "SearchUsage" } ], - "description": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.usageProvider.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1567,27 +1804,200 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/server/search/collectors/usage.ts", - "lineNumber": 22 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "data", + "id": "def-server.AsyncSearchResponse", + "type": "Interface", + "tags": [], + "label": "AsyncSearchResponse", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.AsyncSearchResponse", + "text": "AsyncSearchResponse" + }, + "" + ], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 12 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.AsyncSearchResponse.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 13 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.AsyncSearchResponse.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "SearchResponse", + "" + ], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 14 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.AsyncSearchResponse.start_time_in_millis", + "type": "number", + "tags": [], + "label": "start_time_in_millis", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 15 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.AsyncSearchResponse.expiration_time_in_millis", + "type": "number", + "tags": [], + "label": "expiration_time_in_millis", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 16 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.AsyncSearchResponse.is_partial", + "type": "boolean", + "tags": [], + "label": "is_partial", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 17 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.AsyncSearchResponse.is_running", + "type": "boolean", + "tags": [], + "label": "is_running", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 18 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.AsyncSearchStatusResponse", + "type": "Interface", + "tags": [], + "label": "AsyncSearchStatusResponse", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.AsyncSearchStatusResponse", + "text": "AsyncSearchStatusResponse" + }, + " extends Pick<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.AsyncSearchResponse", + "text": "AsyncSearchResponse" + }, + ", \"id\" | \"start_time_in_millis\" | \"expiration_time_in_millis\" | \"is_partial\" | \"is_running\">" + ], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 20 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.AsyncSearchStatusResponse.completion_status", + "type": "number", + "tags": [], + "label": "completion_status", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 21 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.AsyncSearchStatusResponse._shards", + "type": "Object", + "tags": [], + "label": "_shards", + "description": [], + "signature": [ + "ShardsResponse" + ], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 22 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", "id": "def-server.IScopedSearchClient", "type": "Interface", + "tags": [], "label": "IScopedSearchClient", + "description": [], "signature": [ { "pluginId": "data", @@ -1605,51 +2015,55 @@ "text": "ISearchClient" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 89 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.IScopedSearchClient.saveSession", "type": "Function", + "tags": [], "label": "saveSession", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 90 - }, "signature": [ "(sessionId: string, attributes: Partial) => Promise<", "SavedObject", " | undefined>" - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 90 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IScopedSearchClient.getSession", "type": "Function", + "tags": [], "label": "getSession", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 91 - }, "signature": [ "(sessionId: string) => Promise<", "SavedObject", ">" - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 91 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IScopedSearchClient.findSessions", "type": "Function", + "tags": [], "label": "findSessions", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 92 - }, "signature": [ "(options: Pick<", { @@ -1659,7 +2073,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"filter\" | \"fields\" | \"searchAfter\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\" | \"pit\">) => Promise<", + ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"preference\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"pit\">) => Promise<", { "pluginId": "core", "scope": "server", @@ -1667,19 +2081,21 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - ">" - ] + ">" + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 92 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IScopedSearchClient.updateSession", "type": "Function", + "tags": [], "label": "updateSession", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 93 - }, "signature": [ "(sessionId: string, attributes: Partial) => Promise<", { @@ -1690,46 +2106,52 @@ "text": "SavedObjectsUpdateResponse" }, ">" - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 93 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IScopedSearchClient.cancelSession", "type": "Function", + "tags": [], "label": "cancelSession", "description": [], + "signature": [ + "(sessionId: string) => Promise<{}>" + ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 94 }, - "signature": [ - "(sessionId: string) => Promise<{}>" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IScopedSearchClient.deleteSession", "type": "Function", + "tags": [], "label": "deleteSession", "description": [], + "signature": [ + "(sessionId: string) => Promise<{}>" + ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 95 }, - "signature": [ - "(sessionId: string) => Promise<{}>" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.IScopedSearchClient.extendSession", "type": "Function", + "tags": [], "label": "extendSession", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 96 - }, "signature": [ "(sessionId: string, expires: Date) => Promise<", { @@ -1740,19 +2162,23 @@ "text": "SavedObjectsUpdateResponse" }, ">" - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 96 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 89 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.ISearchSessionService", "type": "Interface", + "tags": [], "label": "ISearchSessionService", + "description": [], "signature": [ { "pluginId": "data", @@ -1763,19 +2189,19 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchSessionService.asScopedProvider", "type": "Function", + "tags": [], "label": "asScopedProvider", "description": [], - "source": { - "path": "src/plugins/data/server/search/session/types.ts", - "lineNumber": 37 - }, "signature": [ "(core: ", { @@ -1796,48 +2222,54 @@ ") => ", "IScopedSearchSessionsClient", "" - ] + ], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 39 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/server/search/session/types.ts", - "lineNumber": 36 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.ISearchSetup", "type": "Interface", + "tags": [], "label": "ISearchSetup", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchSetup.aggs", "type": "Object", + "tags": [], "label": "aggs", "description": [], + "signature": [ + "AggsCommonSetup" + ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 43 }, - "signature": [ - "AggsCommonSetup" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchSetup.registerSearchStrategy", "type": "Function", + "tags": [], "label": "registerSearchStrategy", "description": [ "\nExtension point exposed for other plugins to register their own search\nstrategies." ], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 48 - }, "signature": [ "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 99 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchStart.aggs", "type": "Object", + "tags": [], "label": "aggs", "description": [], + "signature": [ + "AggsStart" + ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 103 }, - "signature": [ - "AggsStart" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchStart.getSearchStrategy", "type": "Function", + "tags": [], "label": "getSearchStrategy", "description": [ "\nGet other registered search strategies by name (or, by default, the Elasticsearch strategy).\nFor example, if a new strategy needs to use the already-registered ES search strategy, it can\nuse this function to accomplish that." ], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 109 - }, "signature": [ "(name?: string | undefined) => ", { @@ -1964,18 +2404,20 @@ "text": "ISearchStrategy" }, "" - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 109 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchStart.asScoped", "type": "Function", + "tags": [], "label": "asScoped", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 112 - }, "signature": [ "(request: ", { @@ -1993,18 +2435,20 @@ "section": "def-server.IScopedSearchClient", "text": "IScopedSearchClient" } - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 112 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchStart.searchSource", "type": "Object", + "tags": [], "label": "searchSource", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 113 - }, "signature": [ "{ asScoped: (request: ", { @@ -2023,19 +2467,25 @@ "text": "ISearchStartSearchSource" }, ">; }" - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 113 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 99 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.ISearchStrategy", "type": "Interface", + "tags": [], "label": "ISearchStrategy", + "description": [ + "\nSearch strategy interface contains a search method that takes in a request and returns a promise\nthat resolves to a response." + ], "signature": [ { "pluginId": "data", @@ -2046,21 +2496,19 @@ }, "" ], - "description": [ - "\nSearch strategy interface contains a search method that takes in a request and returns a promise\nthat resolves to a response." - ], - "tags": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchStrategy.search", "type": "Function", + "tags": [], "label": "search", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 75 - }, "signature": [ "(request: SearchStrategyRequest, options: ", { @@ -2081,18 +2529,20 @@ ") => ", "Observable", "" - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 75 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchStrategy.cancel", "type": "Function", + "tags": [], "label": "cancel", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 80 - }, "signature": [ "((id: string, options: ", { @@ -2111,18 +2561,20 @@ "text": "SearchStrategyDependencies" }, ") => Promise) | undefined" - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 80 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchStrategy.extend", "type": "Function", + "tags": [], "label": "extend", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 81 - }, "signature": [ "((id: string, keepAlive: string, options: ", { @@ -2141,32 +2593,36 @@ "text": "SearchStrategyDependencies" }, ") => Promise) | undefined" - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 81 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 71 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies", "type": "Interface", + "tags": [], "label": "SearchStrategyDependencies", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies.savedObjectsClient", "type": "Object", + "tags": [], "label": "savedObjectsClient", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 36 - }, "signature": [ "Pick<", { @@ -2177,18 +2633,20 @@ "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 36 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies.esClient", "type": "Object", + "tags": [], "label": "esClient", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 37 - }, "signature": [ { "pluginId": "core", @@ -2197,18 +2655,20 @@ "section": "def-server.IScopedClusterClient", "text": "IScopedClusterClient" } - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies.uiSettingsClient", "type": "Object", + "tags": [], "label": "uiSettingsClient", "description": [], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 38 - }, "signature": [ { "pluginId": "core", @@ -2217,107 +2677,121 @@ "section": "def-server.IUiSettingsClient", "text": "IUiSettingsClient" } - ] + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 38 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies.searchSessionsClient", "type": "Object", + "tags": [], "label": "searchSessionsClient", "description": [], + "signature": [ + "IScopedSearchSessionsClient", + "" + ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 39 }, - "signature": [ - "IScopedSearchSessionsClient", - "" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/server/search/types.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.SearchUsage", "type": "Interface", + "tags": [], "label": "SearchUsage", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.SearchUsage.trackError", "type": "Function", + "tags": [], "label": "trackError", + "description": [], "signature": [ "() => Promise" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.SearchUsage.trackSuccess", "type": "Function", + "tags": [], "label": "trackSuccess", + "description": [], "signature": [ "(duration: number) => Promise" ], - "description": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-server.SearchUsage.trackSuccess.$1", "type": "number", + "tags": [], "label": "duration", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/server/search/collectors/usage.ts", - "lineNumber": 19 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/server/search/collectors/usage.ts", - "lineNumber": 17 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "data", "id": "def-server.SearchRequestHandlerContext", "type": "Type", - "label": "SearchRequestHandlerContext", "tags": [], + "label": "SearchRequestHandlerContext", "description": [], + "signature": [ + "IScopedSearchClient" + ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 118 }, - "signature": [ - "IScopedSearchClient" - ], + "deprecated": false, "initialIsOpen": false } ], @@ -2326,16 +2800,29 @@ "common": { "classes": [ { + "parentPluginId": "data", "id": "def-common.AggConfig", "type": "Class", "tags": [], "label": "AggConfig", "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.ensureIds", "type": "Function", + "tags": [ + "return" + ], "label": "ensureIds", + "description": [ + "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" + ], "signature": [ "typeof ", { @@ -2347,42 +2834,47 @@ }, ".ensureIds" ], - "description": [ - "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.ensureIds.$1", "type": "Array", + "tags": [], "label": "list", - "isRequired": true, - "signature": [ - "any[]" - ], "description": [ "- a list of objects, objects can be anything really" ], + "signature": [ + "any[]" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 63 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "- the list that was passed in" - ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 63 - } + ] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.nextId", "type": "Function", + "tags": [ + "return" + ], "label": "nextId", + "description": [ + "\nCalculate the next id based on the ids in this list\n" + ], "signature": [ "typeof ", { @@ -2394,15 +2886,19 @@ }, ".nextId" ], - "description": [ - "\nCalculate the next id based on the ids in this list\n" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.nextId.$1", "type": "Array", + "tags": [], "label": "list", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -2413,34 +2909,25 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "list - a list of objects with id properties" - ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 83 - } + ] }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfig.aggConfigs", "type": "Object", + "tags": [], "label": "aggConfigs", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 92 - }, "signature": [ { "pluginId": "data", @@ -2449,54 +2936,62 @@ "section": "def-common.AggConfigs", "text": "AggConfigs" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 92 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfig.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 93 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfig.enabled", "type": "boolean", + "tags": [], "label": "enabled", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 94 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfig.params", "type": "Any", + "tags": [], "label": "params", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 95 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfig.parent", "type": "Object", + "tags": [], "label": "parent", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 96 - }, "signature": [ { "pluginId": "data", @@ -2506,50 +3001,68 @@ "text": "AggConfigs" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 96 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfig.brandNew", "type": "CompoundType", + "tags": [], "label": "brandNew", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 97 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfig.schema", "type": "string", + "tags": [], "label": "schema", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 98 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.AggConfig.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.Unnamed.$1", "type": "Object", + "tags": [], "label": "aggConfigs", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -2559,17 +3072,20 @@ "text": "AggConfigs" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 104 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.AggConfig.Unnamed.$2", "type": "Object", + "tags": [], "label": "opts", - "isRequired": true, + "description": [], "signature": [ "Pick, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 104 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 104 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.setParams", "type": "Function", - "label": "setParams", - "signature": [ - "(from: any) => void" + "tags": [ + "return" ], + "label": "setParams", "description": [ "\nWrite the current values to this.params, filling in the defaults as we go\n" ], + "signature": [ + "(from: any) => void" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 134 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.setParams.$1", "type": "Any", + "tags": [], "label": "from", - "isRequired": true, - "signature": [ - "any" - ], "description": [ "- optional object to read values from,\n used when initializing" ], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 134 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 134 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getParam", "type": "Function", + "tags": [], "label": "getParam", + "description": [], "signature": [ "(key: string) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 171 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.getParam.$1", "type": "string", + "tags": [], "label": "key", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 171 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 171 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.write", "type": "Function", + "tags": [], "label": "write", + "description": [], "signature": [ "(aggs?: ", { @@ -2688,13 +3213,19 @@ }, " | undefined) => Record" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 175 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.write.$1", "type": "Object", + "tags": [], "label": "aggs", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -2705,85 +3236,98 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 175 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 175 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.isFilterable", "type": "Function", + "tags": [], "label": "isFilterable", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 179 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.createFilter", "type": "Function", + "tags": [], "label": "createFilter", + "description": [], "signature": [ "(key: string, params?: {}) => any" ], - "description": [], - "children": [ - { - "id": "def-common.AggConfig.createFilter.$1", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggConfig.createFilter.$1", "type": "string", + "tags": [], "label": "key", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 183 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.AggConfig.createFilter.$2", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "{}" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 183 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 183 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.onSearchRequestStart", "type": "Function", + "tags": [ + "return" + ], "label": "onSearchRequestStart", + "description": [ + "\n Hook for pre-flight logic, see AggType#onSearchRequestStart" + ], "signature": [ "(searchSource: Pick<", { @@ -2803,15 +3347,19 @@ }, " | undefined) => Promise | Promise" ], - "description": [ - "\n Hook for pre-flight logic, see AggType#onSearchRequestStart" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 209 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.onSearchRequestStart.$1", "type": "Object", + "tags": [], "label": "searchSource", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -2823,17 +3371,20 @@ }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 209 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.AggConfig.onSearchRequestStart.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -2844,26 +3395,27 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 209 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 209 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.toDsl", "type": "Function", + "tags": [ + "return" + ], "label": "toDsl", + "description": [ + "\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n" + ], "signature": [ "(aggConfigs?: ", { @@ -2875,15 +3427,21 @@ }, " | undefined) => any" ], - "description": [ - "\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 230 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.toDsl.$1", "type": "Object", + "tags": [], "label": "aggConfigs", - "isRequired": false, + "description": [ + "- the config object to convert" + ], "signature": [ { "pluginId": "data", @@ -2894,90 +3452,98 @@ }, " | undefined" ], - "description": [ - "- the config object to convert" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 230 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return" - ], "returnComment": [ "- if the config has a dsl representation, it is\n returned, else undefined is returned" - ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 230 - } + ] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.serialize", "type": "Function", + "tags": [], "label": "serialize", + "description": [], "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [ - "Returns a serialized representation of an AggConfig." - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 265 - } + }, + "deprecated": false, + "children": [], + "returnComment": [ + "Returns a serialized representation of an AggConfig." + ] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.toJSON", "type": "Function", + "tags": [ + "deprecated" + ], "label": "toJSON", + "description": [], "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; }" ], - "description": [], - "children": [], - "tags": [ - "deprecated" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 296 - } + }, + "deprecated": true, + "references": [ + { + "plugin": "visualizations", + "link": { + "path": "src/plugins/visualizations/public/vis.ts", + "lineNumber": 172 + } + } + ], + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.toSerializedFieldFormat", "type": "Function", + "tags": [], "label": "toSerializedFieldFormat", - "signature": [ - "() => {}" - ], "description": [ "\nReturns a serialized field format for the field used in this agg.\nThis can be passed to fieldFormats.deserialize to get the field\nformat instance.\n" ], - "children": [], - "tags": [ - "public" + "signature": [ + "() => {}" ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 307 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.toExpressionAst", "type": "Function", + "tags": [], "label": "toExpressionAst", + "description": [], "signature": [ "() => ", { @@ -2989,21 +3555,23 @@ }, " | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [ - "Returns an ExpressionAst representing the this agg type." - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 316 - } + }, + "deprecated": false, + "children": [], + "returnComment": [ + "Returns an ExpressionAst representing the this agg type." + ] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getAggParams", "type": "Function", + "tags": [], "label": "getAggParams", + "description": [], "signature": [ "() => ", { @@ -3023,19 +3591,21 @@ }, ">[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 371 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getRequestAggs", "type": "Function", + "tags": [], "label": "getRequestAggs", + "description": [], "signature": [ "() => ", { @@ -3047,19 +3617,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 375 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getResponseAggs", "type": "Function", + "tags": [], "label": "getResponseAggs", + "description": [], "signature": [ "() => ", { @@ -3071,176 +3643,202 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 379 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getValue", "type": "Function", + "tags": [], "label": "getValue", + "description": [], "signature": [ "(bucket: any) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 383 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.getValue.$1", "type": "Any", + "tags": [], "label": "bucket", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 383 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 383 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getKey", "type": "Function", + "tags": [], "label": "getKey", + "description": [], "signature": [ "(bucket: any, key?: string | undefined) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 387 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.getKey.$1", "type": "Any", + "tags": [], "label": "bucket", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 387 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getKey.$2", "type": "string", + "tags": [], "label": "key", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 387 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 387 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getFieldDisplayName", "type": "Function", + "tags": [], "label": "getFieldDisplayName", + "description": [], "signature": [ "() => any" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 395 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getField", "type": "Function", + "tags": [], "label": "getField", + "description": [], "signature": [ "() => any" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 401 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getValueBucketPath", "type": "Function", + "tags": [], "label": "getValueBucketPath", - "signature": [ - "() => string" - ], "description": [ "\nReturns the bucket path containing the main value the agg will produce\n(e.g. for sum of bytes it will point to the sum, for median it will point\n to the 50 percentile in the percentile multi value bucket)" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 410 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.makeLabel", "type": "Function", + "tags": [], "label": "makeLabel", + "description": [], "signature": [ "(percentageMode?: boolean) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 414 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.makeLabel.$1", "type": "boolean", + "tags": [], "label": "percentageMode", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 414 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 414 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getIndexPattern", "type": "Function", + "tags": [], "label": "getIndexPattern", + "description": [], "signature": [ "() => ", { @@ -3251,19 +3849,21 @@ "text": "IndexPattern" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 428 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.getTimeRange", "type": "Function", + "tags": [], "label": "getTimeRange", + "description": [], "signature": [ "() => ", { @@ -3275,57 +3875,57 @@ }, " | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 432 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.fieldName", "type": "Function", + "tags": [], "label": "fieldName", + "description": [], "signature": [ "() => any" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 436 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.fieldIsTimeField", "type": "Function", + "tags": [], "label": "fieldIsTimeField", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 441 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfig.type", "type": "Object", - "label": "type", "tags": [], + "label": "type", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 452 - }, "signature": [ { "pluginId": "data", @@ -3334,18 +3934,20 @@ "section": "def-common.IAggType", "text": "IAggType" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 452 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.AggConfig.type", "type": "Object", - "label": "type", "tags": [], + "label": "type", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 456 - }, "signature": [ { "pluginId": "data", @@ -3354,12 +3956,20 @@ "section": "def-common.IAggType", "text": "IAggType" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 456 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.AggConfig.setType", "type": "Function", + "tags": [], "label": "setType", + "description": [], "signature": [ "(type: ", { @@ -3371,13 +3981,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 486 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfig.setType.$1", "type": "Object", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3387,44 +4003,39 @@ "text": "IAggType" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 486 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 486 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 55 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggConfigs", "type": "Class", "tags": [], "label": "AggConfigs", "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfigs.indexPattern", "type": "Object", + "tags": [], "label": "indexPattern", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 65 - }, "signature": [ { "pluginId": "data", @@ -3433,18 +4044,20 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 66 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfigs.timeRange", "type": "Object", + "tags": [], "label": "timeRange", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 66 - }, "signature": [ { "pluginId": "data", @@ -3454,32 +4067,52 @@ "text": "TimeRange" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 67 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfigs.timeFields", "type": "Array", + "tags": [], "label": "timeFields", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 67 + "lineNumber": 68 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggConfigs.hierarchical", + "type": "CompoundType", "tags": [], - "id": "def-common.AggConfigs.aggs", - "type": "Array", - "label": "aggs", + "label": "hierarchical", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 70 + "lineNumber": 69 }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.aggs", + "type": "Array", + "tags": [], + "label": "aggs", + "description": [], "signature": [ { "pluginId": "data", @@ -3489,22 +4122,36 @@ "text": "AggConfig" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 73 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 75 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.Unnamed.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3514,17 +4161,20 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 73 - } + "lineNumber": 76 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.Unnamed.$2", "type": "Array", + "tags": [], "label": "configStates", - "isRequired": true, + "description": [], "signature": [ "Pick, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 74 - } + "lineNumber": 77 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.Unnamed.$3", "type": "Object", + "tags": [], "label": "opts", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3566,55 +4219,59 @@ "text": "AggConfigsOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 75 - } + "lineNumber": 78 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 72 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.setTimeFields", "type": "Function", + "tags": [], "label": "setTimeFields", + "description": [], "signature": [ "(timeFields: string[] | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 91 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.setTimeFields.$1", "type": "Array", + "tags": [], "label": "timeFields", - "isRequired": false, + "description": [], "signature": [ "string[] | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 87 - } + "lineNumber": 91 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 87 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.setTimeRange", "type": "Function", + "tags": [], "label": "setTimeRange", + "description": [], "signature": [ "(timeRange: ", { @@ -3626,13 +4283,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 95 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.setTimeRange.$1", "type": "Object", + "tags": [], "label": "timeRange", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3642,24 +4305,23 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 - } + "lineNumber": 95 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.clone", "type": "Function", + "tags": [], "label": "clone", + "description": [], "signature": [ "({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ", { @@ -3670,81 +4332,39 @@ "text": "AggConfigs" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 113 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.clone.$1", "type": "Object", + "tags": [], "label": "{ enabledOnly = true }", - "isRequired": true, + "description": [], "signature": [ "{ enabledOnly?: boolean | undefined; }" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 109 - } + "lineNumber": 113 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 109 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.createAggConfig", "type": "Function", - "children": [ - { - "id": "def-common.AggConfigs.createAggConfig.$1", - "type": "Object", - "label": "params", - "isRequired": true, - "signature": [ - "Pick & Pick<{ type: string | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - }, - "; }, \"type\"> & Pick<{ type: string | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - }, - "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 123 - } - }, - { - "id": "def-common.AggConfigs.createAggConfig.$2", - "type": "Object", - "label": "{ addToAggConfigs = true }", - "isRequired": true, - "signature": [ - "{ addToAggConfigs?: boolean | undefined; }" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 124 - } - } - ], + "tags": [], + "label": "createAggConfig", + "description": [], "signature": [ " & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 127 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.createAggConfig.$2", + "type": "Object", + "tags": [], + "label": "{ addToAggConfigs = true }", + "description": [], + "signature": [ + "{ addToAggConfigs?: boolean | undefined; }" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 128 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.jsonDataEquals", "type": "Function", + "tags": [], "label": "jsonDataEquals", + "description": [ + "\nData-by-data comparison of this Aggregation\nIgnores the non-array indexes" + ], "signature": [ "(aggConfigs: ", { @@ -3805,15 +4482,21 @@ }, "[]) => boolean" ], - "description": [ - "\nData-by-data comparison of this Aggregation\nIgnores the non-array indexes" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 169 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.jsonDataEquals.$1", "type": "Array", + "tags": [], "label": "aggConfigs", - "isRequired": true, + "description": [ + "an AggConfigs instance" + ], "signature": [ { "pluginId": "data", @@ -3824,57 +4507,41 @@ }, "[]" ], - "description": [ - "an AggConfigs instance" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 165 - } + "lineNumber": 169 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 165 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.toDsl", "type": "Function", + "tags": [], "label": "toDsl", - "signature": [ - "(hierarchical?: boolean) => Record" - ], "description": [], - "children": [ - { - "id": "def-common.AggConfigs.toDsl.$1", - "type": "boolean", - "label": "hierarchical", - "isRequired": true, - "signature": [ - "boolean" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 177 - } - } + "signature": [ + "() => Record" ], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 177 - } + "lineNumber": 181 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.getAll", "type": "Function", + "tags": [], "label": "getAll", + "description": [], "signature": [ "() => ", { @@ -3886,19 +4553,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 246 - } + "lineNumber": 250 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.byIndex", "type": "Function", + "tags": [], "label": "byIndex", + "description": [], "signature": [ "(index: number) => ", { @@ -3909,34 +4578,39 @@ "text": "AggConfig" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 254 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.byIndex.$1", "type": "number", + "tags": [], "label": "index", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 250 - } + "lineNumber": 254 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 250 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.byId", "type": "Function", + "tags": [], "label": "byId", + "description": [], "signature": [ "(id: string) => ", { @@ -3948,34 +4622,39 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 258 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.byId.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 - } + "lineNumber": 258 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.byName", "type": "Function", + "tags": [], "label": "byName", + "description": [], "signature": [ "(name: string) => ", { @@ -3987,34 +4666,39 @@ }, "[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 262 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.byName.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 - } + "lineNumber": 262 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.byType", "type": "Function", + "tags": [], "label": "byType", + "description": [], "signature": [ "(type: string) => ", { @@ -4026,34 +4710,39 @@ }, "[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 266 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.byType.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 - } + "lineNumber": 266 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.byTypeName", "type": "Function", + "tags": [], "label": "byTypeName", + "description": [], "signature": [ "(type: string) => ", { @@ -4065,34 +4754,39 @@ }, "[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 270 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.byTypeName.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 - } + "lineNumber": 270 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.bySchemaName", "type": "Function", + "tags": [], "label": "bySchemaName", + "description": [], "signature": [ "(schema: string) => ", { @@ -4104,34 +4798,39 @@ }, "[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 274 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.bySchemaName.$1", "type": "string", + "tags": [], "label": "schema", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 - } + "lineNumber": 274 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.getRequestAggs", "type": "Function", + "tags": [], "label": "getRequestAggs", + "description": [], "signature": [ "() => ", { @@ -4143,19 +4842,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 274 - } + "lineNumber": 278 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.getRequestAggById", "type": "Function", + "tags": [], "label": "getRequestAggById", + "description": [], "signature": [ "(id: string) => ", { @@ -4167,34 +4868,43 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 292 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.getRequestAggById.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 288 - } + "lineNumber": 292 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 288 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.getResponseAggs", "type": "Function", + "tags": [ + "return" + ], "label": "getResponseAggs", + "description": [ + "\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n" + ], "signature": [ "() => ", { @@ -4206,24 +4916,26 @@ }, "[]" ], - "description": [ - "\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n" - ], - "children": [], - "tags": [ - "return" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 303 - } + "lineNumber": 307 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.getResponseAggById", "type": "Function", + "tags": [ + "return" + ], "label": "getResponseAggById", - "signature": [ + "description": [ + "\nFind a response agg by it's id. This may be an agg in the aggConfigs, or one\ncreated specifically for a response value\n" + ], + "signature": [ "(id: string) => ", { "pluginId": "data", @@ -4234,40 +4946,41 @@ }, " | undefined" ], - "description": [ - "\nFind a response agg by it's id. This may be an agg in the aggConfigs, or one\ncreated specifically for a response value\n" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 321 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.getResponseAggById.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- the id of the agg to find" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 317 - } + "lineNumber": 321 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 317 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.onSearchRequestStart", "type": "Function", + "tags": [], "label": "onSearchRequestStart", + "description": [], "signature": [ "(searchSource: Pick<", { @@ -4287,13 +5000,19 @@ }, " | undefined) => Promise<[unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 330 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggConfigs.onSearchRequestStart.$1", "type": "Object", + "tags": [], "label": "searchSource", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -4305,17 +5024,20 @@ }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 - } + "lineNumber": 330 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.onSearchRequestStart.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -4326,28 +5048,21 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 - } + "lineNumber": 330 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 64 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamType", "type": "Class", "tags": [], @@ -4371,76 +5086,87 @@ }, "" ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamType.makeAgg", "type": "Function", + "tags": [], "label": "makeAgg", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", - "lineNumber": 15 - }, "signature": [ "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamType.allowedAggs", "type": "Array", + "tags": [], "label": "allowedAggs", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 16 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.AggParamType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggParamType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", - "lineNumber": 18 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggsCommonService", "type": "Class", "tags": [], @@ -4448,83 +5174,95 @@ "description": [ "\nThe aggs service provides a means of modeling and manipulating the various\nElasticsearch aggregations supported by Kibana, providing the ability to\noutput the correct DSL when you are ready to send your request to ES." ], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 52 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggsCommonService.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "({ registerFunction }: ", "AggsCommonSetupDependencies", ") => ", "AggsCommonSetup" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggsCommonService.setup.$1", "type": "Object", + "tags": [], "label": "{ registerFunction }", - "isRequired": true, + "description": [], "signature": [ "AggsCommonSetupDependencies" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/aggs_service.ts", - "lineNumber": 55 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggsCommonService.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "({ getConfig, getIndexPattern, isDefaultTimezone, }: ", "AggsCommonStartDependencies", ") => ", "AggsCommonStart" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 72 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggsCommonService.start.$1", "type": "Object", + "tags": [], "label": "{\n getConfig,\n getIndexPattern,\n isDefaultTimezone,\n }", - "isRequired": true, + "description": [], "signature": [ "AggsCommonStartDependencies" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "lineNumber": 72 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/aggs_service.ts", - "lineNumber": 72 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/aggs_service.ts", - "lineNumber": 52 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggType", "type": "Class", "tags": [], @@ -4540,322 +5278,334 @@ }, "" ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", + "id": "def-common.AggType.name", + "type": "string", "tags": [ "property", "type" ], - "id": "def-common.AggType.name", - "type": "string", "label": "name", "description": [ "\nthe unique, unchanging, name that we have assigned this aggType\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 71 - } + "lineNumber": 74 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggType.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 73 - } + "lineNumber": 76 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggType.subtype", "type": "string", + "tags": [], "label": "subtype", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 74 + "lineNumber": 77 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.dslName", + "type": "string", "tags": [ "property", "type" ], - "id": "def-common.AggType.dslName", - "type": "string", "label": "dslName", "description": [ "\nthe name of the elasticsearch aggregation that this aggType represents. Usually just this.name\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 81 - } + "lineNumber": 84 + }, + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.expressionName", + "type": "string", "tags": [ "property", "type" ], - "id": "def-common.AggType.expressionName", - "type": "string", "label": "expressionName", "description": [ "\nthe name of the expression function that this aggType represents.\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 88 - } + "lineNumber": 91 + }, + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.title", + "type": "string", "tags": [ "property", "type" ], - "id": "def-common.AggType.title", - "type": "string", "label": "title", "description": [ "\nthe user friendly name that will be shown in the ui for this aggType\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 95 - } + "lineNumber": 98 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggType.valueType", "type": "CompoundType", + "tags": [], "label": "valueType", "description": [ "\nThe type the values produced by this agg will have in the final data table.\nIf not specified, the type of the field is used." ], + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 100 + "lineNumber": 103 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.makeLabel", + "type": "Function", "tags": [ "method" ], - "id": "def-common.AggType.makeLabel", - "type": "Function", "label": "makeLabel", "description": [ "\na function that will be called when this aggType is assigned to\nan aggConfig, and that aggConfig is being rendered (in a form, chart, etc.).\n" ], + "signature": [ + "((aggConfig: TAggConfig) => string) | (() => string)" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 109 + "lineNumber": 112 }, - "signature": [ - "((aggConfig: TAggConfig) => string) | (() => string)" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.ordered", + "type": "Any", "tags": [ "property", "type" ], - "id": "def-common.AggType.ordered", - "type": "Any", "label": "ordered", "description": [ "\nDescribes if this aggType creates data that is ordered, and if that ordered data\nis some sort of time series.\n\nIf the aggType does not create ordered data, set this to something \"falsy\".\n\nIf this does create orderedData, then the value should be an object.\n\nIf the orderdata is some sort of time series, `this.ordered` should be an object\nwith the property `date: true`\n" ], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 124 + "lineNumber": 127 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.hasNoDsl", + "type": "boolean", "tags": [ "type" ], - "id": "def-common.AggType.hasNoDsl", - "type": "boolean", "label": "hasNoDsl", "description": [ "\nFlag that prevents this aggregation from being included in the dsl. This is only\nused by the count aggregation (currently) since it doesn't really exist and it's output\nis available on every bucket.\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 132 - } + "lineNumber": 135 + }, + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.hasNoDslParams", + "type": "boolean", "tags": [ "type" ], - "id": "def-common.AggType.hasNoDslParams", - "type": "boolean", "label": "hasNoDslParams", "description": [ "\nFlag that prevents params from this aggregation from being included in the dsl. Sibling and parent aggs are still written.\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 138 - } + "lineNumber": 141 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggType.createFilter", "type": "Function", + "tags": [], "label": "createFilter", "description": [ "\nThe method to create a filter representation of the bucket" ], + "signature": [ + "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 145 + "lineNumber": 148 }, - "signature": [ - "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.params", + "type": "Array", "tags": [ "property", "type" ], - "id": "def-common.AggType.params", - "type": "Array", "label": "params", "description": [ "\nAn instance of {{#crossLink \"AggParams\"}}{{/crossLink}}.\n" ], + "signature": [ + "TParam[]" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 152 + "lineNumber": 155 }, - "signature": [ - "TParam[]" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.getRequestAggs", + "type": "Function", "tags": [ "method" ], - "id": "def-common.AggType.getRequestAggs", - "type": "Function", "label": "getRequestAggs", "description": [ "\nDesigned for multi-value metric aggs, this method can return a\nset of AggConfigs that should replace this aggConfig in requests\n" ], + "signature": [ + "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 162 + "lineNumber": 165 }, - "signature": [ - "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.getResponseAggs", + "type": "Function", "tags": [ "method" ], - "id": "def-common.AggType.getResponseAggs", - "type": "Function", "label": "getResponseAggs", "description": [ "\nDesigned for multi-value metric aggs, this method can return a\nset of AggConfigs that should replace this aggConfig in result sets\nthat walk the AggConfig set.\n" ], + "signature": [ + "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 173 + "lineNumber": 176 }, - "signature": [ - "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggType.decorateAggConfig", "type": "Function", + "tags": [], "label": "decorateAggConfig", "description": [ "\nA function that will be called each time an aggConfig of this type\nis created, giving the agg type a chance to modify the agg config" ], + "signature": [ + "() => any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 178 + "lineNumber": 181 }, - "signature": [ - "() => any" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.postFlightRequest", + "type": "Function", "tags": [ "return" ], - "id": "def-common.AggType.postFlightRequest", - "type": "Function", "label": "postFlightRequest", "description": [ "\nA function that needs to be called after the main request has been made\nand should return an updated response" ], + "signature": [ + "PostFlightRequestFn" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 191 + "lineNumber": 194 }, - "signature": [ - "(resp: any, aggConfigs: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - ", aggConfig: TAggConfig, searchSource: Pick<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, inspectorRequestAdapter?: ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestAdapter", - "text": "RequestAdapter" - }, - " | undefined, abortSignal?: AbortSignal | undefined, searchSessionId?: string | undefined) => Promise" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.AggType.getSerializedFormat", + "type": "Function", "tags": [ "return" ], - "id": "def-common.AggType.getSerializedFormat", - "type": "Function", "label": "getSerializedFormat", "description": [ "\nGet the serialized format for the values produced by this agg type,\noverridden by several metrics that always output a simple number.\nYou can pass this output to fieldFormatters.deserialize to get\nthe formatter instance.\n" ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 209 - }, "signature": [ "(agg: TAggConfig) => ", { @@ -4866,114 +5616,147 @@ "text": "SerializedFieldFormat" }, ">" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 204 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggType.getValue", "type": "Function", + "tags": [], "label": "getValue", "description": [], + "signature": [ + "(agg: TAggConfig, bucket: any) => any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 211 + "lineNumber": 206 }, - "signature": [ - "(agg: TAggConfig, bucket: any) => any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggType.getKey", "type": "Function", + "tags": [], "label": "getKey", "description": [], + "signature": [ + "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 213 + "lineNumber": 208 }, - "signature": [ - "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.AggType.paramByName", "type": "Function", + "tags": [], + "label": "paramByName", + "description": [], + "signature": [ + "(name: string) => TParam | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 210 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggType.paramByName.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 215 - } + "lineNumber": 210 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(name: string) => TParam | undefined" - ], - "description": [], - "label": "paramByName", - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 215 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggType.getValueBucketPath", "type": "Function", + "tags": [], + "label": "getValueBucketPath", + "description": [], + "signature": [ + "(agg: TAggConfig) => string" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 214 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggType.getValueBucketPath.$1", "type": "Uncategorized", + "tags": [], "label": "agg", - "isRequired": true, + "description": [], "signature": [ "TAggConfig" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 219 - } + "lineNumber": 214 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agg: TAggConfig) => string" - ], - "description": [], - "label": "getValueBucketPath", - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 219 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggType.Unnamed", "type": "Function", - "label": "Constructor", - "signature": [ - "any" + "tags": [ + "class", + "private" ], + "label": "Constructor", "description": [ "\nGeneric AggType Constructor\n\nUsed to create the values exposed by the agg_types module.\n" ], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 227 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [ + "- used to set the properties of the AggType" + ], "signature": [ { "pluginId": "data", @@ -4992,43 +5775,39 @@ }, ">" ], - "description": [ - "- used to set the properties of the AggType" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 232 - } + "lineNumber": 227 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "class", - "private" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 232 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 61 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggTypesRegistry", "type": "Class", "tags": [], "label": "AggTypesRegistry", "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggTypesRegistry.setup", "type": "Function", - "children": [], + "tags": [], + "label": "setup", + "description": [], "signature": [ "() => { registerBucket: >(name: N, type: T) => void; }" ], - "description": [], - "label": "setup", "source": { "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "lineNumber": 31 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggTypesRegistry.start", "type": "Function", - "children": [], + "tags": [], + "label": "start", + "description": [], "signature": [ "() => { get: (name: string) => any; getAll: () => { buckets: any[]; metrics: any[]; }; }" ], - "description": [], - "label": "start", "source": { "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "lineNumber": 60 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.BaseParamType", "type": "Class", "tags": [], @@ -5100,86 +5877,100 @@ }, "" ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.required", "type": "boolean", + "tags": [], "label": "required", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.advanced", "type": "boolean", + "tags": [], "label": "advanced", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.default", "type": "Any", + "tags": [], "label": "default", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 20 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.write", "type": "Function", + "tags": [], "label": "write", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/base.ts", - "lineNumber": 21 - }, "signature": [ "(aggConfig: TAggConfig, output: Record, aggConfigs?: ", { @@ -5190,46 +5981,52 @@ "text": "AggConfigs" }, " | undefined, locals?: Record | undefined) => void" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.serialize", "type": "Function", + "tags": [], "label": "serialize", "description": [], + "signature": [ + "(value: any, aggConfig?: TAggConfig | undefined) => any" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 27 }, - "signature": [ - "(value: any, aggConfig?: TAggConfig | undefined) => any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.deserialize", "type": "Function", + "tags": [], "label": "deserialize", "description": [], + "signature": [ + "(value: any, aggConfig?: TAggConfig | undefined) => any" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 28 }, - "signature": [ - "(value: any, aggConfig?: TAggConfig | undefined) => any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.toExpressionAst", "type": "Function", + "tags": [], "label": "toExpressionAst", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/base.ts", - "lineNumber": 29 - }, "signature": [ "((value: any) => ", { @@ -5240,48 +6037,54 @@ "text": "ExpressionAstExpression" }, " | undefined) | undefined" - ] - }, + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 29 + }, + "deprecated": false + }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.options", "type": "Array", + "tags": [], "label": "options", "description": [], + "signature": [ + "any[]" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 30 }, - "signature": [ - "any[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.valueType", "type": "Any", + "tags": [], "label": "valueType", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 31 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BaseParamType.modifyAggConfigOnSearchRequestStart", "type": "Function", + "tags": [], "label": "modifyAggConfigOnSearchRequestStart", "description": [ "\n A function that will be called before an aggConfig is serialized and sent to ES.\n Allows aggConfig to retrieve values needed for serialization\n Example usage: an aggregation needs to know the min/max of a field to determine an appropriate interval\n" ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/base.ts", - "lineNumber": 45 - }, "signature": [ "(aggConfig: TAggConfig, searchSource?: Pick<", { @@ -5300,47 +6103,54 @@ "text": "ISearchOptions" }, " | undefined) => void" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 45 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.BaseParamType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.BaseParamType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 51 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/base.ts", - "lineNumber": 51 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/base.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.BucketAggType", "type": "Class", "tags": [], @@ -5372,87 +6182,100 @@ }, ">" ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.BucketAggType.getKey", "type": "Function", + "tags": [], "label": "getKey", "description": [], + "signature": [ + "(bucket: any, key: any, agg: TBucketAggConfig) => any" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 35 }, - "signature": [ - "(bucket: any, key: any, agg: TBucketAggConfig) => any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BucketAggType.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 36 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.BucketAggType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.BucketAggType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "BucketAggTypeConfig" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 38 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.CidrMask", "type": "Class", "tags": [], "label": "CidrMask", "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.CidrMask.initialAddress", "type": "Object", + "tags": [], "label": "initialAddress", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "data", @@ -5461,90 +6284,103 @@ "section": "def-common.Ipv4Address", "text": "Ipv4Address" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.CidrMask.prefixLength", "type": "number", + "tags": [], "label": "prefixLength", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.CidrMask.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.CidrMask.Unnamed.$1", "type": "string", + "tags": [], "label": "mask", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", - "lineNumber": 21 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.CidrMask.getRange", "type": "Function", + "tags": [], "label": "getRange", + "description": [], "signature": [ "() => { from: string; to: string; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.CidrMask.toString", "type": "Function", + "tags": [], "label": "toString", + "description": [], "signature": [ "() => string" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 44 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldParamType", "type": "Class", "tags": [], @@ -5576,39 +6412,45 @@ }, ">" ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldParamType.required", "type": "boolean", + "tags": [], "label": "required", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 27 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldParamType.scriptable", "type": "boolean", + "tags": [], "label": "scriptable", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldParamType.filterFieldTypes", "type": "CompoundType", + "tags": [], "label": "filterFieldTypes", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 29 - }, "signature": [ { "pluginId": "data", @@ -5617,74 +6459,70 @@ "section": "def-common.FieldTypes", "text": "FieldTypes" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FieldParamType.onlyAggregatable", "type": "boolean", + "tags": [], "label": "onlyAggregatable", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.FieldParamType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.FieldParamType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 32 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.FieldParamType.getAvailableFields", "type": "Function", - "children": [ - { - "id": "def-common.FieldParamType.getAvailableFields.$1", - "type": "Object", - "label": "aggConfig", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 126 - } - } + "tags": [], + "label": "getAvailableFields", + "description": [ + "\nfilter the fields to the available ones" ], "signature": [ "(aggConfig: ", @@ -5705,25 +6543,43 @@ }, "[]" ], - "description": [ - "\nfilter the fields to the available ones" - ], - "label": "getAvailableFields", "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 126 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.FieldParamType.getAvailableFields.$1", + "type": "Object", + "tags": [], + "label": "aggConfig", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 126 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError", "type": "Class", "tags": [], @@ -5739,88 +6595,104 @@ }, " extends Error" ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$1", "type": "string", + "tags": [], "label": "interval", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$2", "type": "number", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$3", "type": "CompoundType", + "tags": [], "label": "unit", - "isRequired": true, + "description": [], "signature": [ "Unit" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$4", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", - "lineNumber": 13 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.InvalidEsIntervalFormatError", "type": "Class", "tags": [], @@ -5836,123 +6708,141 @@ }, " extends Error" ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.InvalidEsIntervalFormatError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.InvalidEsIntervalFormatError.Unnamed.$1", "type": "string", + "tags": [], "label": "interval", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", - "lineNumber": 12 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.Ipv4Address", "type": "Class", "tags": [], "label": "Ipv4Address", "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.Ipv4Address.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.Ipv4Address.Unnamed.$1", "type": "CompoundType", + "tags": [], "label": "ipAddress", - "isRequired": true, + "description": [], "signature": [ "React.ReactText" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", - "lineNumber": 25 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.Ipv4Address.toString", "type": "Function", + "tags": [], "label": "toString", + "description": [], "signature": [ "() => string" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", "lineNumber": 50 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.Ipv4Address.valueOf", "type": "Function", + "tags": [], "label": "valueOf", + "description": [], "signature": [ "() => number" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.JsonParamType", "type": "Class", "tags": [], @@ -5984,46 +6874,53 @@ }, ">" ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/json.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.JsonParamType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/json.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.JsonParamType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/json.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/json.ts", - "lineNumber": 15 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/json.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.MetricAggType", "type": "Class", "tags": [], @@ -6055,98 +6952,113 @@ }, ">" ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.MetricAggType.subtype", "type": "string", + "tags": [], "label": "subtype", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 41 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.MetricAggType.isScalable", "type": "Function", + "tags": [], "label": "isScalable", "description": [], + "signature": [ + "() => boolean" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 42 }, - "signature": [ - "() => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.MetricAggType.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 43 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.MetricAggType.getKey", "type": "Function", - "children": [], + "tags": [], + "label": "getKey", + "description": [], "signature": [ "() => void" ], - "description": [], - "label": "getKey", "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 45 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.MetricAggType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.MetricAggType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "MetricAggTypeConfig" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 47 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 37 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.OptionedParamType", "type": "Class", "tags": [], @@ -6178,17 +7090,19 @@ }, ">" ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.OptionedParamType.options", "type": "Array", + "tags": [], "label": "options", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 20 - }, "signature": [ { "pluginId": "data", @@ -6198,47 +7112,54 @@ "text": "OptionedValueProp" }, "[]" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 20 + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.OptionedParamType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.OptionedParamType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 22 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.RequestFailure", "type": "Class", "tags": [], @@ -6263,36 +7184,58 @@ "text": "KbnError" } ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.RequestFailure.resp", "type": "Object", + "tags": [], "label": "resp", "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "lineNumber": 19 }, - "signature": [ - "SearchResponse", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.RequestFailure.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.RequestFailure.Unnamed.$1", "type": "CompoundType", + "tags": [], "label": "err", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -6303,79 +7246,95 @@ }, " | null" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.RequestFailure.Unnamed.$2", "type": "Object", + "tags": [], "label": "resp", - "isRequired": false, + "description": [], "signature": [ - "SearchResponse", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", - "lineNumber": 20 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchSource", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "SearchSource", "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 121 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSource.history", "type": "Array", + "tags": [], "label": "history", "description": [], + "signature": [ + "Record[]" + ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 111 + "lineNumber": 129 }, - "signature": [ - "Record[]" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.SearchSource.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 133 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.Unnamed.$1", "type": "Object", + "tags": [], "label": "fields", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -6385,17 +7344,20 @@ "text": "SearchSourceFields" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 - } + "lineNumber": 133 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.SearchSource.Unnamed.$2", "type": "Object", + "tags": [], "label": "dependencies", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -6405,57 +7367,63 @@ "text": "SearchSourceDependencies" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 - } + "lineNumber": 133 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.setPreferredSearchStrategyId", "type": "Function", + "tags": [], "label": "setPreferredSearchStrategyId", - "signature": [ - "(searchStrategyId: string) => void" - ], "description": [ "**\nPUBLIC API\n\ninternal, dont use" ], + "signature": [ + "(searchStrategyId: string) => void" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 151 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.setPreferredSearchStrategyId.$1", "type": "string", + "tags": [], "label": "searchStrategyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 - } + "lineNumber": 151 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.setField", "type": "Function", + "tags": [], "label": "setField", + "description": [ + "\nsets value to a single search source field" + ], "signature": [ "(field: K, value: ", { @@ -6467,31 +7435,40 @@ }, "[K]) => this" ], - "description": [ - "\nsets value to a single search source field" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 160 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.setField.$1", "type": "Uncategorized", + "tags": [], "label": "field", - "isRequired": true, - "signature": [ - "K" - ], "description": [ ": field name" ], + "signature": [ + "K" + ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 - } + "lineNumber": 160 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.SearchSource.setField.$2", "type": "Uncategorized", + "tags": [], "label": "value", - "isRequired": true, + "description": [ + ": value for the field" + ], "signature": [ { "pluginId": "data", @@ -6502,61 +7479,67 @@ }, "[K]" ], - "description": [ - ": value for the field" - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 - } + "lineNumber": 160 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.removeField", "type": "Function", + "tags": [], "label": "removeField", - "signature": [ - "(field: K) => this" - ], "description": [ "\nremove field" ], + "signature": [ + "(field: K) => this" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 172 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.removeField.$1", "type": "Uncategorized", + "tags": [], "label": "field", - "isRequired": true, - "signature": [ - "K" - ], "description": [ ": field name" ], + "signature": [ + "K" + ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154 - } + "lineNumber": 172 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.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: ", { @@ -6568,15 +7551,21 @@ }, ") => this" ], - "description": [ - "\nInternal, do not use. Overrides all search source fields with the new field array.\n" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 183 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.setFields.$1", "type": "Object", + "tags": [], "label": "newFields", - "isRequired": true, + "description": [ + "New field array." + ], "signature": [ { "pluginId": "data", @@ -6586,46 +7575,45 @@ "text": "SearchSourceFields" } ], - "description": [ - "New field array." - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165 - } + "lineNumber": 183 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "private" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getId", "type": "Function", + "tags": [], "label": "getId", - "signature": [ - "() => string" - ], "description": [ "\nreturns search source id" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 173 - } + "lineNumber": 191 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getFields", "type": "Function", + "tags": [], "label": "getFields", + "description": [ + "\nreturns all search source fields" + ], "signature": [ "() => ", { @@ -6636,21 +7624,23 @@ "text": "SearchSourceFields" } ], - "description": [ - "\nreturns all search source fields" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 180 - } + "lineNumber": 198 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getField", "type": "Function", + "tags": [], "label": "getField", + "description": [ + "\nGets a single field from the fields" + ], "signature": [ "(field: K, recurse?: boolean) => ", { @@ -6662,50 +7652,58 @@ }, "[K]" ], - "description": [ - "\nGets a single field from the fields" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 205 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.getField.$1", "type": "Uncategorized", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ "K" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 - } + "lineNumber": 205 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getField.$2", "type": "boolean", + "tags": [], "label": "recurse", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 - } + "lineNumber": 205 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getOwnField", "type": "Function", + "tags": [], "label": "getOwnField", + "description": [ + "\nGet the field from our own fields, don't traverse up the chain" + ], "signature": [ "(field: K) => ", { @@ -6717,36 +7715,41 @@ }, "[K]" ], - "description": [ - "\nGet the field from our own fields, don't traverse up the chain" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 216 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.getOwnField.$1", "type": "Uncategorized", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ "K" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198 - } + "lineNumber": 216 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.create", "type": "Function", + "tags": [ + "deprecated" + ], "label": "create", + "description": [], "signature": [ "() => ", { @@ -6757,21 +7760,39 @@ "text": "SearchSource" } ], - "description": [], - "children": [], - "tags": [ - "deprecated" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 - } + "lineNumber": 223 + }, + "deprecated": true, + "references": [ + { + "plugin": "discover", + "link": { + "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", + "lineNumber": 206 + } + }, + { + "plugin": "discover", + "link": { + "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", + "lineNumber": 212 + } + } + ], + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.createCopy", "type": "Function", + "tags": [], "label": "createCopy", + "description": [ + "\ncreates a copy of this search source (without its children)" + ], "signature": [ "() => ", { @@ -6782,21 +7803,23 @@ "text": "SearchSource" } ], - "description": [ - "\ncreates a copy of this search source (without its children)" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 212 - } + "lineNumber": 230 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.createChild", "type": "Function", + "tags": [], "label": "createChild", + "description": [ + "\ncreates a new child search source" + ], "signature": [ "(options?: {}) => ", { @@ -6807,36 +7830,43 @@ "text": "SearchSource" } ], - "description": [ - "\ncreates a new child search source" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 244 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.createChild.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ "{}" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226 - } + "lineNumber": 244 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.setParent", "type": "Function", + "tags": [ + "return" + ], "label": "setParent", + "description": [ + "\nSet a searchSource that this source should inherit from" + ], "signature": [ "(parent?: Pick<", { @@ -6856,15 +7886,21 @@ }, ") => this" ], - "description": [ - "\nSet a searchSource that this source should inherit from" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 256 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.setParent.$1", "type": "Object", + "tags": [], "label": "parent", - "isRequired": false, + "description": [ + "- the parent searchSource" + ], "signature": [ "Pick<", { @@ -6876,19 +7912,22 @@ }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" ], - "description": [ - "- the parent searchSource" - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 - } + "lineNumber": 256 + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.SearchSource.setParent.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [ + "- the inherit options" + ], "signature": [ { "pluginId": "data", @@ -6898,30 +7937,29 @@ "text": "SearchSourceOptions" } ], - "description": [ - "- the inherit options" - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 - } + "lineNumber": 256 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "- chainable" - ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 - } + ] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getParent", "type": "Function", + "tags": [ + "return" + ], "label": "getParent", + "description": [ + "\nGet the parent of this SearchSource" + ], "signature": [ "() => ", { @@ -6933,23 +7971,23 @@ }, " | undefined" ], - "description": [ - "\nGet the parent of this SearchSource" - ], - "children": [], - "tags": [ - "return" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 248 - } + "lineNumber": 266 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.fetch$", "type": "Function", + "tags": [], "label": "fetch$", + "description": [ + "\nFetch this source from Elasticsearch, returning an observable over the response(s)" + ], "signature": [ "(options?: ", { @@ -6962,18 +8000,30 @@ ") => ", "Observable", "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", "SearchResponse", - ">" - ], - "description": [ - "\nFetch this source from Elasticsearch, returning an observable over the response(s)" + ">>" ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 274 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.fetch$.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -6983,24 +8033,27 @@ "text": "ISearchOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 - } + "lineNumber": 275 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.fetch", "type": "Function", + "tags": [ + "deprecated" + ], "label": "fetch", + "description": [ + "\nFetch this source and reject the returned Promise on error" + ], "signature": [ "(options?: ", { @@ -7014,15 +8067,56 @@ "SearchResponse", ">" ], - "description": [ - "\nFetch this source and reject the returned Promise on error" + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 312 + }, + "deprecated": true, + "references": [ + { + "plugin": "discover", + "link": { + "path": "src/plugins/discover/public/application/angular/context/api/utils/fetch_hits_in_interval.ts", + "lineNumber": 77 + } + }, + { + "plugin": "discover", + "link": { + "path": "src/plugins/discover/public/application/angular/context/api/anchor.ts", + "lineNumber": 57 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts", + "lineNumber": 266 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx", + "lineNumber": 498 + } + }, + { + "plugin": "maps", + "link": { + "path": "x-pack/plugins/maps/public/classes/layers/blended_vector_layer/blended_vector_layer.ts", + "lineNumber": 330 + } + } ], "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.fetch.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -7032,26 +8126,27 @@ "text": "ISearchOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283 - } + "lineNumber": 312 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "deprecated" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.onRequestStart", "type": "Function", + "tags": [ + "return" + ], "label": "onRequestStart", + "description": [ + "\n Add a handler that will be notified whenever requests start" + ], "signature": [ "(handler: (searchSource: ", { @@ -7071,15 +8166,19 @@ }, " | undefined) => Promise) => void" ], - "description": [ - "\n Add a handler that will be notified whenever requests start" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 325 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.onRequestStart.$1", "type": "Function", + "tags": [], "label": "handler", - "isRequired": true, + "description": [], "signature": [ "(searchSource: ", { @@ -7099,64 +8198,67 @@ }, " | undefined) => Promise" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 293 - } + "lineNumber": 326 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 292 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getSearchRequestBody", "type": "Function", + "tags": [], "label": "getSearchRequestBody", - "signature": [ - "() => Promise" - ], "description": [ "\nReturns body contents of the search request, often referred as query DSL." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => any" + ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 301 - } + "lineNumber": 334 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.destroy", "type": "Function", - "label": "destroy", - "signature": [ - "() => void" + "tags": [ + "return" ], + "label": "destroy", "description": [ "\nCompletely destroy the SearchSource." ], - "children": [], - "tags": [ - "return" + "signature": [ + "() => void" ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 310 - } + "lineNumber": 342 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getSerializedFields", "type": "Function", + "tags": [], "label": "getSerializedFields", + "description": [ + "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" + ], "signature": [ "(recurse?: boolean) => ", { @@ -7167,88 +8269,95 @@ "text": "SearchSourceFields" } ], - "description": [ - "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 826 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSource.getSerializedFields.$1", "type": "boolean", + "tags": [], "label": "recurse", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688 - } + "lineNumber": 826 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.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", "[]; }" ], - "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." - ], - "children": [], - "tags": [ - "public" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 717 - } + "lineNumber": 855 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 103 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchSourceService", "type": "Class", "tags": [], "label": "SearchSourceService", "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source_service.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSourceService.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSourceService.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(indexPatterns: Pick<", { @@ -7291,13 +8400,19 @@ "text": "SearchSource" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source_service.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.SearchSourceService.start.$1", "type": "Object", + "tags": [], "label": "indexPatterns", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -7309,17 +8424,20 @@ }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.SearchSourceService.start.$2", "type": "Object", + "tags": [], "label": "dependencies", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -7329,44 +8447,39 @@ "text": "SearchSourceDependencies" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source_service.ts", - "lineNumber": 15 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSourceService.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source_service.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.StringParamType", "type": "Class", "tags": [], @@ -7398,733 +8511,826 @@ }, ">" ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/string.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.StringParamType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/string.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.StringParamType.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/string.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/string.ts", - "lineNumber": 13 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/string.ts", - "lineNumber": 12 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "data", "id": "def-common.aggAvg", "type": "Function", - "children": [], + "tags": [], + "label": "aggAvg", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggAvg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts", "lineNumber": 20 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggBucketAvg", "type": "Function", - "children": [], + "tags": [], + "label": "aggBucketAvg", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggBucketAvg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggBucketMax", "type": "Function", - "children": [], + "tags": [], + "label": "aggBucketMax", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggBucketMax", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggBucketMin", "type": "Function", - "children": [], + "tags": [], + "label": "aggBucketMin", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggBucketMin", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggBucketSum", "type": "Function", - "children": [], + "tags": [], + "label": "aggBucketSum", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggBucketSum", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggCardinality", "type": "Function", - "children": [], + "tags": [], + "label": "aggCardinality", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggCardinality", "source": { "path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggCount", "type": "Function", - "children": [], + "tags": [], + "label": "aggCount", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggCount", "source": { "path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggCumulativeSum", "type": "Function", - "children": [], + "tags": [], + "label": "aggCumulativeSum", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggCumulativeSum", "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts", "lineNumber": 27 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggDateHistogram", "type": "Function", - "children": [], + "tags": [], + "label": "aggDateHistogram", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggDateHistogram", "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggDateRange", "type": "Function", - "children": [], + "tags": [], + "label": "aggDateRange", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggDateRange", "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggDerivative", "type": "Function", - "children": [], + "tags": [], + "label": "aggDerivative", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggDerivative", "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts", "lineNumber": 27 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggFilter", "type": "Function", - "children": [], + "tags": [], + "label": "aggFilter", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggFilter", "source": { "path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggFilteredMetric", "type": "Function", - "children": [], + "tags": [], + "label": "aggFilteredMetric", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggFilteredMetric", "source": { "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggFilters", "type": "Function", - "children": [], + "tags": [], + "label": "aggFilters", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggFilters", "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggGeoBounds", "type": "Function", - "children": [], + "tags": [], + "label": "aggGeoBounds", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggGeoBounds", "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggGeoCentroid", "type": "Function", - "children": [], + "tags": [], + "label": "aggGeoCentroid", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggGeoCentroid", "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggGeoHash", "type": "Function", - "children": [], + "tags": [], + "label": "aggGeoHash", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggGeoHash", "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", "lineNumber": 29 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggGeoTile", "type": "Function", - "children": [], + "tags": [], + "label": "aggGeoTile", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggGeoTile", "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts", "lineNumber": 26 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggHistogram", "type": "Function", - "children": [], + "tags": [], + "label": "aggHistogram", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggHistogram", "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggIpRange", "type": "Function", - "children": [], + "tags": [], + "label": "aggIpRange", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggIpRange", "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggMax", "type": "Function", - "children": [], + "tags": [], + "label": "aggMax", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggMax", "source": { "path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts", "lineNumber": 20 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggMedian", "type": "Function", - "children": [], + "tags": [], + "label": "aggMedian", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggMedian", "source": { "path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggMin", "type": "Function", - "children": [], + "tags": [], + "label": "aggMin", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggMin", "source": { "path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts", "lineNumber": 20 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggMovingAvg", "type": "Function", - "children": [], + "tags": [], + "label": "aggMovingAvg", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggMovingAvg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts", "lineNumber": 27 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggPercentileRanks", "type": "Function", - "children": [], + "tags": [], + "label": "aggPercentileRanks", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggPercentileRanks", "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggPercentiles", "type": "Function", - "children": [], + "tags": [], + "label": "aggPercentiles", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggPercentiles", "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggRange", "type": "Function", - "children": [], + "tags": [], + "label": "aggRange", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggRange", "source": { "path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggSerialDiff", "type": "Function", - "children": [], + "tags": [], + "label": "aggSerialDiff", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggSerialDiff", "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts", "lineNumber": 27 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggSignificantTerms", "type": "Function", - "children": [], + "tags": [], + "label": "aggSignificantTerms", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggSignificantTerms", "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts", "lineNumber": 28 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggSinglePercentile", "type": "Function", - "children": [], + "tags": [], + "label": "aggSinglePercentile", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggSinglePercentile", "source": { "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_fn.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggStdDeviation", "type": "Function", - "children": [], + "tags": [], + "label": "aggStdDeviation", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggStdDeviation", "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggSum", "type": "Function", - "children": [], + "tags": [], + "label": "aggSum", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggSum", "source": { "path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts", "lineNumber": 20 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggTerms", "type": "Function", - "children": [], + "tags": [], + "label": "aggTerms", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggTerms", "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts", "lineNumber": 31 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.aggTopHit", "type": "Function", - "children": [], + "tags": [], + "label": "aggTopHit", + "description": [], "signature": [ "() => FunctionDefinition" ], - "description": [], - "label": "aggTopHit", "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.calcAutoIntervalLessThan", "type": "Function", + "tags": [], "label": "calcAutoIntervalLessThan", - "signature": [ - "(maxBucketCount: number, duration: number) => moment.Duration" - ], "description": [ "\nPick a \"pretty\" interval that produces no more than the maxBucketCount\nfor the given time range.\n" ], + "signature": [ + "(maxBucketCount: number, duration: number) => moment.Duration" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 252 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.calcAutoIntervalLessThan.$1", "type": "number", + "tags": [], "label": "maxBucketCount", - "isRequired": true, - "signature": [ - "number" - ], "description": [ "maximum number of buckets to create" ], + "signature": [ + "number" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 252 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.calcAutoIntervalLessThan.$2", "type": "number", + "tags": [], "label": "duration", - "isRequired": true, - "signature": [ - "number" - ], "description": [ "amount of time covered by the agg" ], + "signature": [ + "number" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 252 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", - "lineNumber": 252 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.calcAutoIntervalNear", "type": "Function", + "tags": [], "label": "calcAutoIntervalNear", - "signature": [ - "(targetBucketCount: number, duration: number) => moment.Duration" - ], "description": [ "\nUsing some simple rules we pick a \"pretty\" interval that will\nproduce around the number of buckets desired given a time range.\n" ], + "signature": [ + "(targetBucketCount: number, duration: number) => moment.Duration" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 225 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.calcAutoIntervalNear.$1", "type": "number", + "tags": [], "label": "targetBucketCount", - "isRequired": true, - "signature": [ - "number" - ], "description": [ "desired number of buckets" ], + "signature": [ + "number" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 225 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.calcAutoIntervalNear.$2", "type": "number", + "tags": [], "label": "duration", - "isRequired": true, - "signature": [ - "number" - ], "description": [ "time range the agg covers" ], + "signature": [ + "number" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 225 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", - "lineNumber": 225 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.convertDateRangeToString", "type": "Function", + "tags": [], "label": "convertDateRangeToString", + "description": [], "signature": [ "({ from, to }: ", { @@ -8136,13 +9342,19 @@ }, ", format: (val: any) => string) => string" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.convertDateRangeToString.$1", "type": "Object", + "tags": [], "label": "{ from, to }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -8152,44 +9364,65 @@ "text": "DateRangeKey" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.convertDateRangeToString.$2", "type": "Function", + "tags": [], "label": "format", - "isRequired": true, + "description": [], "signature": [ "(val: any) => string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.convertIPRangeToString", "type": "Function", + "tags": [], + "label": "convertIPRangeToString", + "description": [], + "signature": [ + "(range: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IpRangeKey", + "text": "IpRangeKey" + }, + ", format: (val: any) => string) => string" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.convertIPRangeToString.$1", "type": "CompoundType", + "tags": [], "label": "range", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -8199,57 +9432,93 @@ "text": "IpRangeKey" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.convertIPRangeToString.$2", "type": "Function", + "tags": [], "label": "format", - "isRequired": true, + "description": [], "signature": [ "(val: any) => string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.createSearchSource", + "type": "Function", + "tags": [ + "return" + ], + "label": "createSearchSource", + "description": [ + "\nDeserializes a json string and a set of referenced objects to a `SearchSource` instance.\nUse this method to re-create the search source serialized using `searchSource.serialize`.\n\nThis function is a factory function that returns the actual utility when calling it with the\nrequired service dependency (index patterns contract). A pre-wired version is also exposed in\nthe start contract of the data plugin as part of the search service\n" + ], "signature": [ - "(range: ", + "(indexPatterns: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, searchSourceDependencies: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IpRangeKey", - "text": "IpRangeKey" + "section": "def-common.SearchSourceDependencies", + "text": "SearchSourceDependencies" }, - ", format: (val: any) => string) => string" + ") => (searchSourceFields?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ">" ], - "description": [], - "label": "convertIPRangeToString", "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", - "lineNumber": 22 + "path": "src/plugins/data/common/search/search_source/create_search_source.ts", + "lineNumber": 31 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.createSearchSource", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.createSearchSource.$1", "type": "Object", + "tags": [], "label": "indexPatterns", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -8261,17 +9530,20 @@ }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/create_search_source.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.createSearchSource.$2", "type": "Object", + "tags": [], "label": "searchSourceDependencies", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -8281,126 +9553,67 @@ "text": "SearchSourceDependencies" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/create_search_source.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "Wired utility function taking two parameters `searchSourceJson`, the json string\nreturned by `serializeSearchSource` and `references`, a list of references including the ones\nreturned by `serializeSearchSource`." + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.dateHistogramInterval", + "type": "Function", + "tags": [], + "label": "dateHistogramInterval", + "description": [ + "\nChecks whether a given Elasticsearch interval is a calendar or fixed interval\nand returns an object containing the appropriate date_histogram property for that\ninterval. So it will return either an object containing the fixed_interval key for\nthat interval or a calendar_interval. If the specified interval was not a valid Elasticsearch\ninterval this method will throw an error.\n\nYou can simply spread the returned value of this method into your date_histogram." + ], "signature": [ - "(indexPatterns: Pick<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" - }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, searchSourceDependencies: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceDependencies", - "text": "SearchSourceDependencies" - }, - ") => (searchSourceFields?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - ") => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - ">" - ], - "description": [ - "\nDeserializes a json string and a set of referenced objects to a `SearchSource` instance.\nUse this method to re-create the search source serialized using `searchSource.serialize`.\n\nThis function is a factory function that returns the actual utility when calling it with the\nrequired service dependency (index patterns contract). A pre-wired version is also exposed in\nthe start contract of the data plugin as part of the search service\n" - ], - "label": "createSearchSource", - "source": { - "path": "src/plugins/data/common/search/search_source/create_search_source.ts", - "lineNumber": 31 - }, - "tags": [ - "return", - "public" - ], - "returnComment": [ - "Wired utility function taking two parameters `searchSourceJson`, the json string\nreturned by `serializeSearchSource` and `references`, a list of references including the ones\nreturned by `serializeSearchSource`." - ], - "initialIsOpen": false - }, - { - "id": "def-common.dateHistogramInterval", - "type": "Function", - "label": "dateHistogramInterval", - "signature": [ - "(interval: string) => Interval" - ], - "description": [ - "\nChecks whether a given Elasticsearch interval is a calendar or fixed interval\nand returns an object containing the appropriate date_histogram property for that\ninterval. So it will return either an object containing the fixed_interval key for\nthat interval or a calendar_interval. If the specified interval was not a valid Elasticsearch\ninterval this method will throw an error.\n\nYou can simply spread the returned value of this method into your date_histogram." - ], - "children": [ + "(interval: string) => Interval" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "lineNumber": 31 + }, + "deprecated": false, + "children": [ { + "parentPluginId": "data", "id": "def-common.dateHistogramInterval.$1", "type": "string", + "tags": [], "label": "interval", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "The interval string to return the appropriate date_histogram key for." ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.extractReferences", "type": "Function", - "children": [ - { - "id": "def-common.extractReferences.$1", - "type": "Object", - "label": "state", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/extract_references.ts", - "lineNumber": 14 - } - } - ], + "tags": [], + "label": "extractReferences", + "description": [], "signature": [ "(state: ", { @@ -8422,142 +9635,46 @@ "SavedObjectReference", "[]]" ], - "description": [], - "label": "extractReferences", "source": { "path": "src/plugins/data/common/search/search_source/extract_references.ts", "lineNumber": 13 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.fetchSoon", - "type": "Function", - "label": "fetchSoon", - "signature": [ - "(request: Record, options: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - ", fetchHandlers: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.FetchHandlers", - "text": "FetchHandlers" - }, - ") => Promise<", - "SearchResponse", - ">" - ], - "description": [ - "\nThis function introduces a slight delay in the request process to allow multiple requests to queue\nup (e.g. when a dashboard is loading)." - ], + "deprecated": false, "children": [ { - "id": "def-common.fetchSoon.$1", - "type": "Object", - "label": "request", - "isRequired": true, - "signature": [ - "Record" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", - "lineNumber": 20 - } - }, - { - "id": "def-common.fetchSoon.$2", + "parentPluginId": "data", + "id": "def-common.extractReferences.$1", "type": "Object", - "label": "options", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - } - ], + "tags": [], + "label": "state", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", - "lineNumber": 21 - } - }, - { - "id": "def-common.fetchSoon.$3", - "type": "Object", - "label": "fetchHandlers", - "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.FetchHandlers", - "text": "FetchHandlers" + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" } ], - "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", - "lineNumber": 22 - } + "path": "src/plugins/data/common/search/search_source/extract_references.ts", + "lineNumber": 14 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.filtersToAst", "type": "Function", - "children": [ - { - "id": "def-common.filtersToAst.$1", - "type": "CompoundType", - "label": "filters", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - " | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/filters_to_ast.ts", - "lineNumber": 13 - } - } - ], + "tags": [], + "label": "filtersToAst", + "description": [], "signature": [ "(filters: ", { @@ -8585,41 +9702,57 @@ }, "[]" ], - "description": [], - "label": "filtersToAst", "source": { "path": "src/plugins/data/common/search/expressions/filters_to_ast.ts", "lineNumber": 13 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.functionWrapper", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.functionWrapper.$1", - "type": "Object", - "label": "spec", - "isRequired": true, + "parentPluginId": "data", + "id": "def-common.filtersToAst.$1", + "type": "CompoundType", + "tags": [], + "label": "filters", + "description": [], "signature": [ { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" - } + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" ], - "description": [], "source": { - "path": "src/plugins/data/common/search/expressions/utils/function_wrapper.ts", - "lineNumber": 16 - } + "path": "src/plugins/data/common/search/expressions/filters_to_ast.ts", + "lineNumber": 13 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.functionWrapper", + "type": "Function", + "tags": [], + "label": "functionWrapper", + "description": [ + "\nTakes a function spec and passes in default args,\noverriding with any provided args." + ], "signature": [ "(spec: ", { @@ -8649,24 +9782,48 @@ "SerializableState", ">) => any" ], - "description": [ - "\nTakes a function spec and passes in default args,\noverriding with any provided args." - ], - "label": "functionWrapper", "source": { "path": "src/plugins/data/common/search/expressions/utils/function_wrapper.ts", "lineNumber": 16 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getAvgMetricAgg", - "type": "Function", - "children": [], - "signature": [ - "() => ", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.functionWrapper.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + } + ], + "source": { + "path": "src/plugins/data/common/search/expressions/utils/function_wrapper.ts", + "lineNumber": 16 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getAvgMetricAgg", + "type": "Function", + "tags": [], + "label": "getAvgMetricAgg", + "description": [], + "signature": [ + "() => ", { "pluginId": "data", "scope": "common", @@ -8684,20 +9841,22 @@ }, ">" ], - "description": [], - "label": "getAvgMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getBucketAvgMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getBucketAvgMetricAgg", + "description": [], "signature": [ "() => ", { @@ -8717,20 +9876,22 @@ }, ">" ], - "description": [], - "label": "getBucketAvgMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", "lineNumber": 31 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getBucketMaxMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getBucketMaxMetricAgg", + "description": [], "signature": [ "() => ", { @@ -8750,20 +9911,22 @@ }, ">" ], - "description": [], - "label": "getBucketMaxMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getBucketMinMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getBucketMinMetricAgg", + "description": [], "signature": [ "() => ", { @@ -8783,20 +9946,22 @@ }, ">" ], - "description": [], - "label": "getBucketMinMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getBucketSumMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getBucketSumMetricAgg", + "description": [], "signature": [ "() => ", { @@ -8816,20 +9981,22 @@ }, ">" ], - "description": [], - "label": "getBucketSumMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getCalculateAutoTimeExpression", "type": "Function", + "tags": [], "label": "getCalculateAutoTimeExpression", + "description": [], "signature": [ "(getConfig: (key: string) => any) => (range: ", { @@ -8841,35 +10008,40 @@ }, ") => string | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getCalculateAutoTimeExpression.$1", "type": "Function", + "tags": [], "label": "getConfig", - "isRequired": true, + "description": [], "signature": [ "(key: string) => any" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getCardinalityMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getCardinalityMetricAgg", + "description": [], "signature": [ "() => ", { @@ -8889,20 +10061,22 @@ }, ">" ], - "description": [], - "label": "getCardinalityMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getCountMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getCountMetricAgg", + "description": [], "signature": [ "() => ", { @@ -8922,20 +10096,22 @@ }, ">" ], - "description": [], - "label": "getCountMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/count.ts", "lineNumber": 14 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getCumulativeSumMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getCumulativeSumMetricAgg", + "description": [], "signature": [ "() => ", { @@ -8955,41 +10131,22 @@ }, ">" ], - "description": [], - "label": "getCumulativeSumMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "lineNumber": 31 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getDateHistogramBucketAgg", "type": "Function", - "children": [ - { - "id": "def-common.getDateHistogramBucketAgg.$1", - "type": "Object", - "label": "{\n calculateBounds,\n isDefaultTimezone,\n getConfig,\n}", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.DateHistogramBucketAggDependencies", - "text": "DateHistogramBucketAggDependencies" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 76 - } - } - ], + "tags": [], + "label": "getDateHistogramBucketAgg", + "description": [], "signature": [ "({ calculateBounds, isDefaultTimezone, getConfig, }: ", { @@ -9017,41 +10174,48 @@ }, ">" ], - "description": [], - "label": "getDateHistogramBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 76 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getDateHistogramMetaDataByDatatableColumn", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.getDateHistogramMetaDataByDatatableColumn.$1", + "parentPluginId": "data", + "id": "def-common.getDateHistogramBucketAgg.$1", "type": "Object", - "label": "column", - "isRequired": true, + "tags": [], + "label": "{\n calculateBounds,\n isDefaultTimezone,\n getConfig,\n}", + "description": [], "signature": [ { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" + "docId": "kibDataSearchPluginApi", + "section": "def-common.DateHistogramBucketAggDependencies", + "text": "DateHistogramBucketAggDependencies" } ], - "description": [], "source": { - "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", - "lineNumber": 20 - } + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 76 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getDateHistogramMetaDataByDatatableColumn", + "type": "Function", + "tags": [], + "label": "getDateHistogramMetaDataByDatatableColumn", + "description": [ + "\nHelper function returning the used interval, used time zone and applied time filters for data table column created by the date_histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a date_histogram aggregation of the esaggs data source,\nthis function will return undefined." + ], "signature": [ "(column: ", { @@ -9071,43 +10235,46 @@ }, " | undefined; } | undefined" ], - "description": [ - "\nHelper function returning the used interval, used time zone and applied time filters for data table column created by the date_histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a date_histogram aggregation of the esaggs data source,\nthis function will return undefined." - ], - "label": "getDateHistogramMetaDataByDatatableColumn", "source": { "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", "lineNumber": 20 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getDateRangeBucketAgg", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.getDateRangeBucketAgg.$1", + "parentPluginId": "data", + "id": "def-common.getDateHistogramMetaDataByDatatableColumn.$1", "type": "Object", - "label": "{\n isDefaultTimezone,\n getConfig,\n}", - "isRequired": true, + "tags": [], + "label": "column", + "description": [], "signature": [ { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.DateRangeBucketAggDependencies", - "text": "DateRangeBucketAggDependencies" + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" } ], - "description": [], "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", - "lineNumber": 37 - } + "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", + "lineNumber": 20 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getDateRangeBucketAgg", + "type": "Function", + "tags": [], + "label": "getDateRangeBucketAgg", + "description": [], "signature": [ "({ isDefaultTimezone, getConfig, }: ", { @@ -9135,20 +10302,46 @@ }, ">" ], - "description": [], - "label": "getDateRangeBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 37 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getDateRangeBucketAgg.$1", + "type": "Object", + "tags": [], + "label": "{\n isDefaultTimezone,\n getConfig,\n}", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.DateRangeBucketAggDependencies", + "text": "DateRangeBucketAggDependencies" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 37 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getDerivativeMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getDerivativeMetricAgg", + "description": [], "signature": [ "() => ", { @@ -9168,54 +10361,26 @@ }, ">" ], - "description": [], - "label": "getDerivativeMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "lineNumber": 31 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getEsdslFn", "type": "Function", - "children": [ - { - "id": "def-common.getEsdslFn.$1.getStartDependencies", - "type": "Object", - "label": "{\n getStartDependencies,\n}", - "tags": [], - "description": [], - "children": [ - { - "tags": [], - "id": "def-common.getEsdslFn.$1.getStartDependencies.getStartDependencies", - "type": "Function", - "label": "getStartDependencies", - "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/esdsl.ts", - "lineNumber": 45 - }, - "signature": [ - "(getKibanaRequest: any) => Promise<", - "EsdslStartDependencies", - ">" - ] - } - ], - "source": { - "path": "src/plugins/data/common/search/expressions/esdsl.ts", - "lineNumber": 44 - } - } - ], - "signature": [ - "({ getStartDependencies, }: { getStartDependencies: (getKibanaRequest: any) => Promise<", - "EsdslStartDependencies", - ">; }) => ", + "tags": [], + "label": "getEsdslFn", + "description": [], + "signature": [ + "({ getStartDependencies, }: { getStartDependencies: (getKibanaRequest: any) => Promise<", + "EsdslStartDependencies", + ">; }) => ", { "pluginId": "data", "scope": "common", @@ -9224,48 +10389,56 @@ "text": "EsdslExpressionFunctionDefinition" } ], - "description": [], - "label": "getEsdslFn", "source": { "path": "src/plugins/data/common/search/expressions/esdsl.ts", "lineNumber": 42 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getFilterBucketAgg", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.getFilterBucketAgg.$1.getConfig", + "parentPluginId": "data", + "id": "def-common.getEsdslFn.$1.getStartDependencies", "type": "Object", - "label": "{ getConfig }", "tags": [], + "label": "{\n getStartDependencies,\n}", "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-common.getFilterBucketAgg.$1.getConfig.getConfig", + "parentPluginId": "data", + "id": "def-common.getEsdslFn.$1.getStartDependencies.getStartDependencies", "type": "Function", - "label": "getConfig", + "tags": [], + "label": "getStartDependencies", "description": [], + "signature": [ + "(getKibanaRequest: any) => Promise<", + "EsdslStartDependencies", + ">" + ], "source": { - "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", - "lineNumber": 27 + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 45 }, - "signature": [ - "(key: string) => any" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", - "lineNumber": 27 - } + ] } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getFilterBucketAgg", + "type": "Function", + "tags": [], + "label": "getFilterBucketAgg", + "description": [], "signature": [ "({ getConfig }: { getConfig: (key: string) => any; }) => ", { @@ -9285,20 +10458,54 @@ }, ">" ], - "description": [], - "label": "getFilterBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "lineNumber": 27 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getFilterBucketAgg.$1.getConfig", + "type": "Object", + "tags": [], + "label": "{ getConfig }", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", + "lineNumber": 27 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getFilterBucketAgg.$1.getConfig.getConfig", + "type": "Function", + "tags": [], + "label": "getConfig", + "description": [], + "signature": [ + "(key: string) => any" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", + "lineNumber": 27 + }, + "deprecated": false + } + ] + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getFilteredMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getFilteredMetricAgg", + "description": [], "signature": [ "() => ", { @@ -9318,41 +10525,22 @@ }, ">" ], - "description": [], - "label": "getFilteredMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getFiltersBucketAgg", "type": "Function", - "children": [ - { - "id": "def-common.getFiltersBucketAgg.$1", - "type": "Object", - "label": "{ getConfig }", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.FiltersBucketAggDependencies", - "text": "FiltersBucketAggDependencies" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", - "lineNumber": 43 - } - } - ], + "tags": [], + "label": "getFiltersBucketAgg", + "description": [], "signature": [ "({ getConfig }: ", { @@ -9380,20 +10568,46 @@ }, ">" ], - "description": [], - "label": "getFiltersBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "lineNumber": 43 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getFiltersBucketAgg.$1", + "type": "Object", + "tags": [], + "label": "{ getConfig }", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FiltersBucketAggDependencies", + "text": "FiltersBucketAggDependencies" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 43 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getGeoBoundsMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getGeoBoundsMetricAgg", + "description": [], "signature": [ "() => ", { @@ -9413,20 +10627,22 @@ }, ">" ], - "description": [], - "label": "getGeoBoundsMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", "lineNumber": 28 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getGeoCentroidMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getGeoCentroidMetricAgg", + "description": [], "signature": [ "() => ", { @@ -9446,20 +10662,22 @@ }, ">" ], - "description": [], - "label": "getGeoCentroidMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", "lineNumber": 28 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getGeoHashBucketAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getGeoHashBucketAgg", + "description": [], "signature": [ "() => ", { @@ -9479,20 +10697,22 @@ }, ">" ], - "description": [], - "label": "getGeoHashBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 37 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getGeoTitleBucketAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getGeoTitleBucketAgg", + "description": [], "signature": [ "() => ", { @@ -9504,41 +10724,22 @@ }, "" ], - "description": [], - "label": "getGeoTitleBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "lineNumber": 29 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getHistogramBucketAgg", "type": "Function", - "children": [ - { - "id": "def-common.getHistogramBucketAgg.$1", - "type": "Object", - "label": "{\n getConfig,\n getFieldFormatsStart,\n}", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.HistogramBucketAggDependencies", - "text": "HistogramBucketAggDependencies" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "lineNumber": 51 - } - } - ], + "tags": [], + "label": "getHistogramBucketAgg", + "description": [], "signature": [ "({ getConfig, getFieldFormatsStart, }: ", { @@ -9566,20 +10767,46 @@ }, ">" ], - "description": [], - "label": "getHistogramBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 51 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getHistogramBucketAgg.$1", + "type": "Object", + "tags": [], + "label": "{\n getConfig,\n getFieldFormatsStart,\n}", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.HistogramBucketAggDependencies", + "text": "HistogramBucketAggDependencies" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 51 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getIpRangeBucketAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getIpRangeBucketAgg", + "description": [], "signature": [ "() => ", { @@ -9599,45 +10826,22 @@ }, ">" ], - "description": [], - "label": "getIpRangeBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "lineNumber": 38 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getKibanaContextFn", "type": "Function", - "children": [ - { - "id": "def-common.getKibanaContextFn.$1", - "type": "Function", - "label": "getStartDependencies", - "isRequired": true, - "signature": [ - "(getKibanaRequest: (() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") | undefined) => Promise<", - "KibanaContextStartDependencies", - ">" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_context.ts", - "lineNumber": 52 - } - } - ], + "tags": [], + "label": "getKibanaContextFn", + "description": [], "signature": [ "(getStartDependencies: (getKibanaRequest: (() => ", { @@ -9658,20 +10862,50 @@ "text": "ExpressionFunctionKibanaContext" } ], - "description": [], - "label": "getKibanaContextFn", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 51 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getKibanaContextFn.$1", + "type": "Function", + "tags": [], + "label": "getStartDependencies", + "description": [], + "signature": [ + "(getKibanaRequest: (() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") | undefined) => Promise<", + "KibanaContextStartDependencies", + ">" + ], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 52 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getMaxMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getMaxMetricAgg", + "description": [], "signature": [ "() => ", { @@ -9691,20 +10925,22 @@ }, ">" ], - "description": [], - "label": "getMaxMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/max.ts", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getMedianMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getMedianMetricAgg", + "description": [], "signature": [ "() => ", { @@ -9724,20 +10960,22 @@ }, ">" ], - "description": [], - "label": "getMedianMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/median.ts", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getMinMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getMinMetricAgg", + "description": [], "signature": [ "() => ", { @@ -9757,20 +10995,22 @@ }, ">" ], - "description": [], - "label": "getMinMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/min.ts", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getMovingAvgMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getMovingAvgMetricAgg", + "description": [], "signature": [ "() => ", { @@ -9790,40 +11030,23 @@ }, ">" ], - "description": [], - "label": "getMovingAvgMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 33 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getNumberHistogramIntervalByDatatableColumn", "type": "Function", - "children": [ - { - "id": "def-common.getNumberHistogramIntervalByDatatableColumn.$1", - "type": "Object", - "label": "column", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", - "lineNumber": 19 - } - } + "tags": [], + "label": "getNumberHistogramIntervalByDatatableColumn", + "description": [ + "\nHelper function returning the used interval for data table column created by the histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a histogram aggregation of the esaggs data source,\nthis function will return undefined." ], "signature": [ "(column: ", @@ -9836,43 +11059,46 @@ }, ") => number | undefined" ], - "description": [ - "\nHelper function returning the used interval for data table column created by the histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a histogram aggregation of the esaggs data source,\nthis function will return undefined." - ], - "label": "getNumberHistogramIntervalByDatatableColumn", "source": { "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", "lineNumber": 19 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getPercentileRanksMetricAgg", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.getPercentileRanksMetricAgg.$1", + "parentPluginId": "data", + "id": "def-common.getNumberHistogramIntervalByDatatableColumn.$1", "type": "Object", - "label": "{\n getFieldFormatsStart,\n}", - "isRequired": true, + "tags": [], + "label": "column", + "description": [], "signature": [ { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.PercentileRanksMetricAggDependencies", - "text": "PercentileRanksMetricAggDependencies" + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" } ], - "description": [], "source": { - "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", - "lineNumber": 52 - } + "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", + "lineNumber": 19 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getPercentileRanksMetricAgg", + "type": "Function", + "tags": [], + "label": "getPercentileRanksMetricAgg", + "description": [], "signature": [ "({ getFieldFormatsStart, }: ", { @@ -9894,20 +11120,46 @@ "IResponseAggConfig", ">" ], - "description": [], - "label": "getPercentileRanksMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 52 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getPercentileRanksMetricAgg.$1", + "type": "Object", + "tags": [], + "label": "{\n getFieldFormatsStart,\n}", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.PercentileRanksMetricAggDependencies", + "text": "PercentileRanksMetricAggDependencies" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 52 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getPercentilesMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getPercentilesMetricAgg", + "description": [], "signature": [ "() => ", { @@ -9921,20 +11173,22 @@ "IResponseAggConfig", ">" ], - "description": [], - "label": "getPercentilesMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "lineNumber": 38 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getPreference", "type": "Function", + "tags": [], "label": "getPreference", + "description": [], "signature": [ "(getConfig: ", { @@ -9946,13 +11200,19 @@ }, ") => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getPreference.$1", "type": "Function", + "tags": [], "label": "getConfig", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -9962,46 +11222,24 @@ "text": "GetConfigFn" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getRangeBucketAgg", "type": "Function", - "children": [ - { - "id": "def-common.getRangeBucketAgg.$1", - "type": "Object", - "label": "{ getFieldFormatsStart }", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.RangeBucketAggDependencies", - "text": "RangeBucketAggDependencies" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/range.ts", - "lineNumber": 38 - } - } - ], + "tags": [], + "label": "getRangeBucketAgg", + "description": [], "signature": [ "({ getFieldFormatsStart }: ", { @@ -10029,22 +11267,50 @@ }, ">" ], - "description": [], - "label": "getRangeBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 38 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getRangeBucketAgg.$1", + "type": "Object", + "tags": [], + "label": "{ getFieldFormatsStart }", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.RangeBucketAggDependencies", + "text": "RangeBucketAggDependencies" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 38 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getRequestInspectorStats", + "parentPluginId": "data", + "id": "def-common.getResponseInspectorStats", "type": "Function", - "label": "getRequestInspectorStats", + "tags": [], + "label": "getResponseInspectorStats", + "description": [], "signature": [ - "(searchSource: Pick<", + "(resp: ", + "SearchResponse", + " | undefined, searchSource: Pick<", { "pluginId": "data", "scope": "common", @@ -10052,7 +11318,7 @@ "section": "def-common.SearchSource", "text": "SearchSource" }, - ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">) => ", + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined) => ", { "pluginId": "inspector", "scope": "common", @@ -10061,87 +11327,37 @@ "text": "RequestStatistics" } ], - "description": [], - "children": [ - { - "id": "def-common.getRequestInspectorStats.$1", - "type": "Object", - "label": "searchSource", - "isRequired": true, - "signature": [ - "Pick<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", - "lineNumber": 22 - } - } - ], - "tags": [ - "public" - ], - "returnComment": [], "source": { - "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", - "lineNumber": 22 + "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", + "lineNumber": 52 }, - "initialIsOpen": false - }, - { - "id": "def-common.getResponseInspectorStats", - "type": "Function", - "label": "getResponseInspectorStats", - "signature": [ - "(resp: ", - "SearchResponse", - ", searchSource: Pick<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined) => ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestStatistics", - "text": "RequestStatistics" - } - ], - "description": [], + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getResponseInspectorStats.$1", "type": "Object", + "tags": [], "label": "resp", - "isRequired": true, + "description": [], "signature": [ "SearchResponse", - "" + " | undefined" ], - "description": [], "source": { - "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", + "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.getResponseInspectorStats.$2", "type": "Object", + "tags": [], "label": "searchSource", - "isRequired": false, + "description": [], "signature": [ "Pick<", { @@ -10153,27 +11369,24 @@ }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" ], - "description": [], "source": { - "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", + "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "public" - ], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", - "lineNumber": 52 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getSearchParams", "type": "Function", + "tags": [], "label": "getSearchParams", + "description": [], "signature": [ "(getConfig: ", { @@ -10185,13 +11398,19 @@ }, ") => { preference: any; }" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getSearchParams.$1", "type": "Function", + "tags": [], "label": "getConfig", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -10201,25 +11420,24 @@ "text": "GetConfigFn" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getSearchParamsFromRequest", "type": "Function", + "tags": [], "label": "getSearchParamsFromRequest", + "description": [], "signature": [ "(searchRequest: Record, dependencies: { getConfig: ", { @@ -10238,39 +11456,49 @@ "text": "ISearchRequestParams" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getSearchParamsFromRequest.$1", "type": "Object", + "tags": [], "label": "searchRequest", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.getSearchParamsFromRequest.$2.dependencies", "type": "Object", - "label": "dependencies", "tags": [], + "label": "dependencies", "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.getSearchParamsFromRequest.$2.dependencies.getConfig", "type": "Function", + "tags": [], "label": "getConfig", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "lineNumber": 35 - }, "signature": [ { "pluginId": "data", @@ -10279,29 +11507,26 @@ "section": "def-common.GetConfigFn", "text": "GetConfigFn" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "lineNumber": 35 - } + ] } ], - "tags": [ - "public" - ], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "lineNumber": 33 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getSerialDiffMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getSerialDiffMetricAgg", + "description": [], "signature": [ "() => ", { @@ -10321,20 +11546,22 @@ }, ">" ], - "description": [], - "label": "getSerialDiffMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "lineNumber": 31 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getSignificantTermsBucketAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getSignificantTermsBucketAgg", + "description": [], "signature": [ "() => ", { @@ -10354,20 +11581,22 @@ }, ">" ], - "description": [], - "label": "getSignificantTermsBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 29 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getSinglePercentileMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getSinglePercentileMetricAgg", + "description": [], "signature": [ "() => ", { @@ -10387,20 +11616,22 @@ }, ">" ], - "description": [], - "label": "getSinglePercentileMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getStdDeviationMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getStdDeviationMetricAgg", + "description": [], "signature": [ "() => ", { @@ -10420,20 +11651,22 @@ }, ">" ], - "description": [], - "label": "getStdDeviationMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 73 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getSumMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getSumMetricAgg", + "description": [], "signature": [ "() => ", { @@ -10453,20 +11686,22 @@ }, ">" ], - "description": [], - "label": "getSumMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getTermsBucketAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getTermsBucketAgg", + "description": [], "signature": [ "() => ", { @@ -10486,20 +11721,22 @@ }, ">" ], - "description": [], - "label": "getTermsBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 65 + "lineNumber": 63 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getTopHitMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getTopHitMetricAgg", + "description": [], "signature": [ "() => ", { @@ -10511,37 +11748,24 @@ }, "" ], - "description": [], - "label": "getTopHitMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 31 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.handleRequest", "type": "Function", - "children": [ - { - "id": "def-common.handleRequest.$1", - "type": "Object", - "label": "{\n abortSignal,\n aggs,\n filters,\n indexPattern,\n inspectorAdapters,\n metricsAtAllLevels,\n partialRows,\n query,\n searchSessionId,\n searchSourceService,\n timeFields,\n timeRange,\n getNow,\n}", - "isRequired": true, - "signature": [ - "RequestHandlerParams" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", - "lineNumber": 44 - } - } - ], + "tags": [], + "label": "handleRequest", + "description": [], "signature": [ - "({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, metricsAtAllLevels, partialRows, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, }: ", + "({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, partialRows, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, }: ", "RequestHandlerParams", ") => Promise<", { @@ -10553,20 +11777,40 @@ }, ">" ], - "description": [], - "label": "handleRequest", "source": { "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", - "lineNumber": 44 + "lineNumber": 43 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "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}", + "description": [], + "signature": [ + "RequestHandlerParams" + ], + "source": { + "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", + "lineNumber": 43 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.inferTimeZone", "type": "Function", + "tags": [], "label": "inferTimeZone", + "description": [], "signature": [ "(params: ", { @@ -10586,13 +11830,19 @@ }, ", isDefaultTimezone: () => boolean, getConfig: (key: string) => T) => string" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.inferTimeZone.$1", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -10602,17 +11852,20 @@ "text": "AggParamsDateHistogram" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.inferTimeZone.$2", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -10622,193 +11875,235 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.inferTimeZone.$3", "type": "Function", + "tags": [], "label": "isDefaultTimezone", - "isRequired": true, + "description": [], "signature": [ "() => boolean" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.inferTimeZone.$4", "type": "Function", + "tags": [], "label": "getConfig", - "isRequired": true, + "description": [], "signature": [ "(key: string) => T" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.injectReferences", "type": "Function", - "children": [ + "tags": [], + "label": "injectReferences", + "description": [], + "signature": [ + "(searchSourceFields: ", { - "id": "def-common.injectReferences.$1", - "type": "CompoundType", - "label": "searchSourceFields", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " & { indexRefName: string; }, references: ", + "SavedObjectReference", + "[]) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "lineNumber": 12 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.injectReferences.$1", + "type": "CompoundType", + "tags": [], + "label": "searchSourceFields", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " & { indexRefName: string; }" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/inject_references.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.injectReferences.$2", "type": "Array", + "tags": [], "label": "references", - "isRequired": true, + "description": [], "signature": [ "SavedObjectReference", "[]" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/inject_references.ts", "lineNumber": 14 - } - } - ], - "signature": [ - "(searchSourceFields: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - " & { indexRefName: string; }, references: ", - "SavedObjectReference", - "[]) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "injectReferences", - "source": { - "path": "src/plugins/data/common/search/search_source/inject_references.ts", - "lineNumber": 12 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isAutoInterval", "type": "Function", + "tags": [], + "label": "isAutoInterval", + "description": [], + "signature": [ + "(value: unknown) => boolean" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isAutoInterval.$1", "type": "Unknown", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: unknown) => boolean" - ], - "description": [], - "label": "isAutoInterval", - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", - "lineNumber": 13 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isBucketAggType", "type": "Function", + "tags": [], "label": "isBucketAggType", + "description": [], "signature": [ "(aggConfig: any) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isBucketAggType.$1", "type": "Any", + "tags": [], "label": "aggConfig", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 49 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isCompleteResponse", "type": "Function", + "tags": [], + "label": "isCompleteResponse", + "description": [], + "signature": [ + "(response?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined) => boolean" + ], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isCompleteResponse.$1", "type": "Object", + "tags": [], "label": "response", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -10819,77 +12114,87 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(response?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined) => boolean" - ], - "description": [], - "label": "isCompleteResponse", - "source": { - "path": "src/plugins/data/common/search/utils.ts", - "lineNumber": 21 - }, - "tags": [], "returnComment": [ "true if response is completed successfully" ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isDateHistogramBucketAggConfig", "type": "Function", + "tags": [], "label": "isDateHistogramBucketAggConfig", + "description": [], "signature": [ "(agg: any) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isDateHistogramBucketAggConfig.$1", "type": "Any", + "tags": [], "label": "agg", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isErrorResponse", "type": "Function", + "tags": [], + "label": "isErrorResponse", + "description": [], + "signature": [ + "(response?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined) => boolean | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isErrorResponse.$1", "type": "Object", + "tags": [], "label": "response", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -10900,78 +12205,63 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(response?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined) => boolean | undefined" - ], - "description": [], - "label": "isErrorResponse", - "source": { - "path": "src/plugins/data/common/search/utils.ts", - "lineNumber": 14 - }, - "tags": [], "returnComment": [ "true if response had an error while executing in ES" ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isMetricAggType", "type": "Function", + "tags": [], "label": "isMetricAggType", + "description": [], "signature": [ "(aggConfig: any) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 75 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isMetricAggType.$1", "type": "Any", + "tags": [], "label": "aggConfig", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 75 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 75 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.isNumberType", "type": "Function", + "tags": [], "label": "isNumberType", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "lineNumber": 21 - }, "signature": [ "(agg: ", { @@ -10983,17 +12273,44 @@ }, ") => boolean" ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isPartialResponse", "type": "Function", + "tags": [], + "label": "isPartialResponse", + "description": [], + "signature": [ + "(response?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined) => boolean" + ], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isPartialResponse.$1", "type": "Object", + "tags": [], "label": "response", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -11004,46 +12321,26 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(response?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined) => boolean" - ], - "description": [], - "label": "isPartialResponse", - "source": { - "path": "src/plugins/data/common/search/utils.ts", - "lineNumber": 28 - }, - "tags": [], "returnComment": [ "true if request is still running an/d response contains partial results" ], "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.isStringOrNumberType", "type": "Function", + "tags": [], "label": "isStringOrNumberType", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "lineNumber": 23 - }, "signature": [ "(agg: ", { @@ -11055,18 +12352,20 @@ }, ") => boolean" ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 23 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.isStringType", "type": "Function", + "tags": [], "label": "isStringType", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "lineNumber": 22 - }, "signature": [ "(agg: ", { @@ -11078,27 +12377,20 @@ }, ") => boolean" ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 22 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isType", "type": "Function", - "children": [ - { - "id": "def-common.isType.$1", - "type": "Array", - "label": "types", - "isRequired": true, - "signature": [ - "string[]" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "lineNumber": 13 - } - } - ], + "tags": [], + "label": "isType", + "description": [], "signature": [ "(...types: string[]) => (agg: ", { @@ -11110,268 +12402,395 @@ }, ") => boolean" ], - "description": [], - "label": "isType", "source": { "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "lineNumber": 13 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.isType.$1", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 13 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isValidEsInterval", "type": "Function", + "tags": [], "label": "isValidEsInterval", - "signature": [ - "(interval: string) => boolean" - ], "description": [ "\nChecks whether a given interval string (e.g. 1w, 24h, ...) is a valid Elasticsearch interval.\nWill return false if the interval is not valid in Elasticsearch, otherwise true.\nInvalid intervals might be: 2f, since there is no unit 'f'; 2w, since weeks and month intervals\nare only allowed with a value of 1, etc.\n" ], + "signature": [ + "(interval: string) => boolean" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isValidEsInterval.$1", "type": "string", + "tags": [], "label": "interval", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "The interval string like 1w, 24h" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "True if the interval is valid for Elasticsearch" ], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.isValidInterval", "type": "Function", + "tags": [], "label": "isValidInterval", + "description": [], "signature": [ "(value: string, baseInterval: string | undefined) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.isValidInterval.$1", "type": "string", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.isValidInterval.$2", "type": "string", + "tags": [], "label": "baseInterval", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.parseEsInterval", "type": "Function", + "tags": [], "label": "parseEsInterval", + "description": [ + "\nExtracts interval properties from an ES interval string. Disallows unrecognized interval formats\nand fractional values. Converts some intervals from \"calendar\" to \"fixed\" when the number of\nunits is larger than 1, and throws an error for others.\n\nConversion rules:\n\n| Interval | Single unit type | Multiple units type |\n| -------- | ---------------- | ------------------- |\n| ms | fixed | fixed |\n| s | fixed | fixed |\n| m | calendar | fixed |\n| h | calendar | fixed |\n| d | calendar | fixed |\n| w | calendar | N/A - disallowed |\n| M | calendar | N/A - disallowed |\n| y | calendar | N/A - disallowed |\n" + ], "signature": [ "(interval: string) => { value: number; unit: ", "Unit", "; type: \"calendar\" | \"fixed\"; }" ], - "description": [ - "\nExtracts interval properties from an ES interval string. Disallows unrecognized interval formats\nand fractional values. Converts some intervals from \"calendar\" to \"fixed\" when the number of\nunits is larger than 1, and throws an error for others.\n\nConversion rules:\n\n| Interval | Single unit type | Multiple units type |\n| -------- | ---------------- | ------------------- |\n| ms | fixed | fixed |\n| s | fixed | fixed |\n| m | calendar | fixed |\n| h | calendar | fixed |\n| d | calendar | fixed |\n| w | calendar | N/A - disallowed |\n| M | calendar | N/A - disallowed |\n| y | calendar | N/A - disallowed |\n" - ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.parseEsInterval.$1", "type": "string", + "tags": [], "label": "interval", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", - "lineNumber": 39 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.parseInterval", "type": "Function", + "tags": [], "label": "parseInterval", + "description": [], "signature": [ "(interval: string) => moment.Duration | null" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.parseInterval.$1", "type": "string", + "tags": [], "label": "interval", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.parseSearchSourceJSON", "type": "Function", + "tags": [], + "label": "parseSearchSourceJSON", + "description": [], + "signature": [ + "(searchSourceJSON: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/parse_json.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.parseSearchSourceJSON.$1", "type": "string", + "tags": [], "label": "searchSourceJSON", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/parse_json.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.pollSearch", + "type": "Function", + "tags": [], + "label": "pollSearch", + "description": [], "signature": [ - "(searchSourceJSON: string) => ", + ">(search: () => Promise, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAsyncSearchOptions", + "text": "IAsyncSearchOptions" + }, + ") => ", + "Observable", + "" ], - "description": [], - "label": "parseSearchSourceJSON", "source": { - "path": "src/plugins/data/common/search/search_source/parse_json.ts", - "lineNumber": 12 + "path": "src/plugins/data/common/search/poll_search.ts", + "lineNumber": 18 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.pollSearch.$1", + "type": "Function", + "tags": [], + "label": "search", + "description": [], + "signature": [ + "() => Promise" + ], + "source": { + "path": "src/plugins/data/common/search/poll_search.ts", + "lineNumber": 19 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.pollSearch.$2", + "type": "Function", + "tags": [], + "label": "cancel", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/poll_search.ts", + "lineNumber": 20 + }, + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-common.pollSearch.$3", + "type": "Object", + "tags": [], + "label": "{ pollInterval = 1000, abortSignal }", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAsyncSearchOptions", + "text": "IAsyncSearchOptions" + } + ], + "source": { + "path": "src/plugins/data/common/search/poll_search.ts", + "lineNumber": 21 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.propFilter", "type": "Function", + "tags": [], "label": "propFilter", - "signature": [ - "(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" - ], "description": [ "\nFilters out a list by a given filter. This is currently used to implement:\n - fieldType filters a list of fields by their type property\n - aggFilter filters a list of aggs by their name property\n" ], + "signature": [ + "(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.propFilter.$1", "type": "Uncategorized", + "tags": [], "label": "prop", - "isRequired": true, + "description": [], "signature": [ "P" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [ "the filter function which can be registered with angular" ], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.queryToAst", "type": "Function", - "children": [ - { - "id": "def-common.queryToAst.$1", - "type": "Object", - "label": "query", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/query_to_ast.ts", - "lineNumber": 14 - } - } - ], + "tags": [], + "label": "queryToAst", + "description": [], "signature": [ "(query: ", { @@ -11390,145 +12809,87 @@ "text": "ExpressionAstExpressionBuilder" } ], - "description": [], - "label": "queryToAst", "source": { "path": "src/plugins/data/common/search/expressions/query_to_ast.ts", "lineNumber": 14 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.splitStringInterval", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.splitStringInterval.$1", - "type": "string", - "label": "interval", - "isRequired": true, + "parentPluginId": "data", + "id": "def-common.queryToAst.$1", + "type": "Object", + "tags": [], + "label": "query", + "description": [], "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } ], - "description": [], "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "lineNumber": 16 - } + "path": "src/plugins/data/common/search/expressions/query_to_ast.ts", + "lineNumber": 14 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.splitStringInterval", + "type": "Function", + "tags": [], + "label": "splitStringInterval", + "description": [], "signature": [ "(interval: string) => { value: number; unit: ", "Unit", "; } | null" ], - "description": [], - "label": "splitStringInterval", "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "lineNumber": 16 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.tabify", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.tabify.$1", - "type": "Object", - "label": "searchSource", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/tabify/index.ts", - "lineNumber": 16 - } - }, - { - "id": "def-common.tabify.$2", - "type": "Object", - "label": "esResponse", - "isRequired": true, - "signature": [ - "SearchResponse", - "" - ], + "parentPluginId": "data", + "id": "def-common.splitStringInterval.$1", + "type": "string", + "tags": [], + "label": "interval", "description": [], - "source": { - "path": "src/plugins/data/common/search/tabify/index.ts", - "lineNumber": 17 - } - }, - { - "id": "def-common.tabify.$3", - "type": "CompoundType", - "label": "opts", - "isRequired": true, "signature": [ - "Partial<", - "TabbedResponseWriterOptions", - "> | ", - "TabifyDocsOptions" + "string" ], - "description": [], "source": { - "path": "src/plugins/data/common/search/tabify/index.ts", - "lineNumber": 18 - } - } - ], - "signature": [ - "(searchSource: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - ", esResponse: ", - "SearchResponse", - ", opts: Partial<", - "TabbedResponseWriterOptions", - "> | ", - "TabifyDocsOptions", - ") => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 16 + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "tabify", - "source": { - "path": "src/plugins/data/common/search/tabify/index.ts", - "lineNumber": 15 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.tabifyAggResponse", "type": "Function", + "tags": [], "label": "tabifyAggResponse", + "description": [ + "\nSets up the ResponseWriter and kicks off bucket collection." + ], "signature": [ "(aggConfigs: ", { @@ -11549,15 +12910,19 @@ "text": "Datatable" } ], - "description": [ - "\nSets up the ResponseWriter and kicks off bucket collection." - ], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.tabifyAggResponse.$1", "type": "Object", + "tags": [], "label": "aggConfigs", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -11567,75 +12932,113 @@ "text": "AggConfigs" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.tabifyAggResponse.$2", "type": "Object", + "tags": [], "label": "esResponse", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.tabifyAggResponse.$3", "type": "Object", + "tags": [], "label": "respOpts", - "isRequired": false, + "description": [], "signature": [ "Partial<", "TabbedResponseWriterOptions", "> | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.tabifyDocs", "type": "Function", + "tags": [], + "label": "tabifyDocs", + "description": [], + "signature": [ + "(esResponse: ", + "SearchResponse", + ", index?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined, params?: ", + "TabifyDocsOptions", + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.tabifyDocs.$1", "type": "Object", + "tags": [], "label": "esResponse", - "isRequired": true, + "description": [], "signature": [ "SearchResponse", "" ], - "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "lineNumber": 75 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.tabifyDocs.$2", "type": "Object", + "tags": [], "label": "index", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -11646,63 +13049,43 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "lineNumber": 76 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.tabifyDocs.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "TabifyDocsOptions" ], - "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "lineNumber": 77 - } - } - ], - "signature": [ - "(esResponse: ", - "SearchResponse", - ", index?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " | undefined, params?: ", - "TabifyDocsOptions", - ") => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "tabifyDocs", - "source": { - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", - "lineNumber": 74 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.tabifyGetColumns", "type": "Function", + "tags": [], "label": "tabifyGetColumns", + "description": [ + "\nBuilds tabify columns.\n" + ], "signature": [ "(aggs: ", { @@ -11716,15 +13099,21 @@ "TabbedAggColumn", "[]" ], - "description": [ - "\nBuilds tabify columns.\n" - ], + "source": { + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.tabifyGetColumns.$1", "type": "Array", + "tags": [], "label": "aggs", - "isRequired": true, + "description": [ + "- the agg configs object to which the aggregation response correlates" + ], "signature": [ { "pluginId": "data", @@ -11735,64 +13124,43 @@ }, "[]" ], - "description": [ - "- the agg configs object to which the aggregation response correlates" - ], "source": { "path": "src/plugins/data/common/search/tabify/get_columns.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.tabifyGetColumns.$2", "type": "boolean", + "tags": [], "label": "minimalColumns", - "isRequired": true, - "signature": [ - "boolean" - ], "description": [ "- setting to true will only return a column for the last bucket/metric instead of one for each level" ], + "signature": [ + "boolean" + ], "source": { "path": "src/plugins/data/common/search/tabify/get_columns.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/tabify/get_columns.ts", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.timerangeToAst", "type": "Function", - "children": [ - { - "id": "def-common.timerangeToAst.$1", - "type": "Object", - "label": "timerange", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/timerange_to_ast.ts", - "lineNumber": 13 - } - } - ], + "tags": [], + "label": "timerangeToAst", + "description": [], "signature": [ "(timerange: ", { @@ -11820,20 +13188,46 @@ }, ">" ], - "description": [], - "label": "timerangeToAst", "source": { "path": "src/plugins/data/common/search/expressions/timerange_to_ast.ts", "lineNumber": 13 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.timerangeToAst.$1", + "type": "Object", + "tags": [], + "label": "timerange", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ], + "source": { + "path": "src/plugins/data/common/search/expressions/timerange_to_ast.ts", + "lineNumber": 13 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.toAbsoluteDates", "type": "Function", + "tags": [], "label": "toAbsoluteDates", + "description": [], "signature": [ "(range: ", { @@ -11845,13 +13239,19 @@ }, ") => { from: Date; to: Date; } | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.toAbsoluteDates.$1", "type": "Object", + "tags": [], "label": "range", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -11861,576 +13261,675 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", - "lineNumber": 12 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "data", "id": "def-common.AggConfigsOptions", "type": "Interface", + "tags": [], "label": "AggConfigsOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfigsOptions.typesRegistry", "type": "Object", + "tags": [], "label": "typesRegistry", "description": [], + "signature": [ + "AggTypesRegistryStart" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 45 }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigsOptions.hierarchical", + "type": "CompoundType", + "tags": [], + "label": "hierarchical", + "description": [], "signature": [ - "AggTypesRegistryStart" - ] + "boolean | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 46 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping", "type": "Interface", + "tags": [], "label": "AggFunctionsMapping", "description": [ "\nA global list of the expression function definitions for each agg type function." ], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 195 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggFilter", "type": "Object", + "tags": [], "label": "aggFilter", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 196 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggFilters", "type": "Object", + "tags": [], "label": "aggFilters", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 197 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggSignificantTerms", "type": "Object", + "tags": [], "label": "aggSignificantTerms", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 198 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggIpRange", "type": "Object", + "tags": [], "label": "aggIpRange", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 199 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggDateRange", "type": "Object", + "tags": [], "label": "aggDateRange", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 200 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggRange", "type": "Object", + "tags": [], "label": "aggRange", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 201 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggGeoTile", "type": "Object", + "tags": [], "label": "aggGeoTile", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 202 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggGeoHash", "type": "Object", + "tags": [], "label": "aggGeoHash", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 203 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggHistogram", "type": "Object", + "tags": [], "label": "aggHistogram", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 204 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggDateHistogram", "type": "Object", + "tags": [], "label": "aggDateHistogram", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 205 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggTerms", "type": "Object", + "tags": [], "label": "aggTerms", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 206 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggAvg", "type": "Object", + "tags": [], "label": "aggAvg", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 207 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggBucketAvg", "type": "Object", + "tags": [], "label": "aggBucketAvg", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 208 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggBucketMax", "type": "Object", + "tags": [], "label": "aggBucketMax", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 209 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggBucketMin", "type": "Object", + "tags": [], "label": "aggBucketMin", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 210 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggBucketSum", "type": "Object", + "tags": [], "label": "aggBucketSum", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 211 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggFilteredMetric", "type": "Object", + "tags": [], "label": "aggFilteredMetric", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 212 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggCardinality", "type": "Object", + "tags": [], "label": "aggCardinality", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 213 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggCount", "type": "Object", + "tags": [], "label": "aggCount", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 214 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggCumulativeSum", "type": "Object", + "tags": [], "label": "aggCumulativeSum", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 215 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggDerivative", "type": "Object", + "tags": [], "label": "aggDerivative", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 216 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggGeoBounds", "type": "Object", + "tags": [], "label": "aggGeoBounds", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 217 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggGeoCentroid", "type": "Object", + "tags": [], "label": "aggGeoCentroid", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 218 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggMax", "type": "Object", + "tags": [], "label": "aggMax", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 219 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggMedian", "type": "Object", + "tags": [], "label": "aggMedian", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 220 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggSinglePercentile", "type": "Object", + "tags": [], "label": "aggSinglePercentile", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 221 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggMin", "type": "Object", + "tags": [], "label": "aggMin", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 222 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggMovingAvg", "type": "Object", + "tags": [], "label": "aggMovingAvg", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 223 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggPercentileRanks", "type": "Object", + "tags": [], "label": "aggPercentileRanks", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 224 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggPercentiles", "type": "Object", + "tags": [], "label": "aggPercentiles", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 225 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggSerialDiff", "type": "Object", + "tags": [], "label": "aggSerialDiff", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 226 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggStdDeviation", "type": "Object", + "tags": [], "label": "aggStdDeviation", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 227 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggSum", "type": "Object", + "tags": [], "label": "aggSum", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 228 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggTopHit", "type": "Object", + "tags": [], "label": "aggTopHit", "description": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 229 }, - "signature": [ - "FunctionDefinition" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 195 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamOption", "type": "Interface", + "tags": [], "label": "AggParamOption", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamOption.val", "type": "string", + "tags": [], "label": "val", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamOption.display", "type": "string", + "tags": [], "label": "display", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.AggParamOption.enabled", "type": "Function", + "tags": [], "label": "enabled", + "description": [], "signature": [ "((agg: ", { @@ -12442,13 +13941,19 @@ }, ") => boolean) | undefined" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.AggParamOption.enabled.$1", "type": "Object", + "tags": [], "label": "agg", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -12458,31 +13963,26 @@ "text": "AggConfig" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_params.ts", - "lineNumber": 33 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_params.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsAvg", "type": "Interface", + "tags": [], "label": "AggParamsAvg", + "description": [], "signature": [ { "pluginId": "data", @@ -12494,31 +13994,35 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsAvg.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsBucketAvg", "type": "Interface", + "tags": [], "label": "AggParamsBucketAvg", + "description": [], "signature": [ { "pluginId": "data", @@ -12530,52 +14034,58 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsBucketAvg.customMetric", "type": "Object", + "tags": [], "label": "customMetric", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", - "lineNumber": 19 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsBucketAvg.customBucket", "type": "Object", + "tags": [], "label": "customBucket", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", - "lineNumber": 20 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", + "lineNumber": 20 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsBucketMax", "type": "Interface", + "tags": [], "label": "AggParamsBucketMax", + "description": [], "signature": [ { "pluginId": "data", @@ -12587,52 +14097,58 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsBucketMax.customMetric", "type": "Object", + "tags": [], "label": "customMetric", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", - "lineNumber": 18 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsBucketMax.customBucket", "type": "Object", + "tags": [], "label": "customBucket", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", - "lineNumber": 19 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 19 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsBucketMin", "type": "Interface", + "tags": [], "label": "AggParamsBucketMin", + "description": [], "signature": [ { "pluginId": "data", @@ -12644,52 +14160,58 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsBucketMin.customMetric", "type": "Object", + "tags": [], "label": "customMetric", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", - "lineNumber": 18 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsBucketMin.customBucket", "type": "Object", + "tags": [], "label": "customBucket", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", - "lineNumber": 19 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", + "lineNumber": 19 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsBucketSum", "type": "Interface", + "tags": [], "label": "AggParamsBucketSum", + "description": [], "signature": [ { "pluginId": "data", @@ -12701,52 +14223,58 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsBucketSum.customMetric", "type": "Object", + "tags": [], "label": "customMetric", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", - "lineNumber": 18 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsBucketSum.customBucket", "type": "Object", + "tags": [], "label": "customBucket", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", - "lineNumber": 19 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 19 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsCardinality", "type": "Interface", + "tags": [], "label": "AggParamsCardinality", + "description": [], "signature": [ { "pluginId": "data", @@ -12758,31 +14286,35 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsCardinality.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsCumulativeSum", "type": "Interface", + "tags": [], "label": "AggParamsCumulativeSum", + "description": [], "signature": [ { "pluginId": "data", @@ -12794,64 +14326,72 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsCumulativeSum.buckets_path", "type": "string", + "tags": [], "label": "buckets_path", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsCumulativeSum.customMetric", "type": "Object", + "tags": [], "label": "customMetric", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", - "lineNumber": 19 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsCumulativeSum.metricAgg", "type": "string", + "tags": [], "label": "metricAgg", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram", "type": "Interface", + "tags": [], "label": "AggParamsDateHistogram", + "description": [], "signature": [ { "pluginId": "data", @@ -12863,19 +14403,19 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.field", "type": "CompoundType", + "tags": [], "label": "field", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 62 - }, "signature": [ "string | ", { @@ -12886,18 +14426,20 @@ "text": "IFieldType" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 62 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.timeRange", "type": "Object", + "tags": [], "label": "timeRange", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 63 - }, "signature": [ { "pluginId": "data", @@ -12907,160 +14449,184 @@ "text": "TimeRange" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 63 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.useNormalizedEsInterval", "type": "CompoundType", + "tags": [], "label": "useNormalizedEsInterval", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 64 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.scaleMetricValues", "type": "CompoundType", + "tags": [], "label": "scaleMetricValues", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 65 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.interval", "type": "string", + "tags": [], "label": "interval", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 66 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.used_interval", "type": "string", + "tags": [], "label": "used_interval", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 67 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.time_zone", "type": "string", + "tags": [], "label": "time_zone", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 68 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.used_time_zone", "type": "string", + "tags": [], "label": "used_time_zone", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 69 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.drop_partials", "type": "CompoundType", + "tags": [], "label": "drop_partials", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 70 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.format", "type": "string", + "tags": [], "label": "format", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 71 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.min_doc_count", "type": "number", + "tags": [], "label": "min_doc_count", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 72 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.extended_bounds", "type": "Object", + "tags": [], "label": "extended_bounds", "description": [], + "signature": [ + "ExtendedBounds", + " | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 73 }, - "signature": [ - "ExtendedBounds", - " | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 61 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsDateRange", "type": "Interface", + "tags": [], "label": "AggParamsDateRange", + "description": [], "signature": [ { "pluginId": "data", @@ -13072,33 +14638,35 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateRange.field", "type": "string", + "tags": [], "label": "field", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 32 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateRange.ranges", "type": "Array", + "tags": [], "label": "ranges", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", - "lineNumber": 33 - }, "signature": [ { "pluginId": "data", @@ -13108,33 +14676,39 @@ "text": "DateRangeKey" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDateRange.time_zone", "type": "string", + "tags": [], "label": "time_zone", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 34 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsDerivative", "type": "Interface", + "tags": [], "label": "AggParamsDerivative", + "description": [], "signature": [ { "pluginId": "data", @@ -13146,64 +14720,72 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDerivative.buckets_path", "type": "string", + "tags": [], "label": "buckets_path", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDerivative.customMetric", "type": "Object", + "tags": [], "label": "customMetric", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", - "lineNumber": 19 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsDerivative.metricAgg", "type": "string", + "tags": [], "label": "metricAgg", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsFilter", "type": "Interface", + "tags": [], "label": "AggParamsFilter", + "description": [], "signature": [ { "pluginId": "data", @@ -13215,34 +14797,38 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsFilter.geo_bounding_box", "type": "CompoundType", + "tags": [], "label": "geo_bounding_box", "description": [], + "signature": [ + "Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "lineNumber": 24 }, - "signature": [ - "Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsFilteredMetric", "type": "Interface", + "tags": [], "label": "AggParamsFilteredMetric", + "description": [], "signature": [ { "pluginId": "data", @@ -13254,52 +14840,58 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsFilteredMetric.customMetric", "type": "Object", + "tags": [], "label": "customMetric", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", - "lineNumber": 18 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsFilteredMetric.customBucket", "type": "Object", + "tags": [], "label": "customBucket", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", - "lineNumber": 19 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", + "lineNumber": 19 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsFilters", "type": "Interface", + "tags": [], "label": "AggParamsFilters", + "description": [], "signature": [ { "pluginId": "data", @@ -13312,19 +14904,19 @@ "BaseAggParams", ", \"json\">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsFilters.filters", "type": "Array", + "tags": [], "label": "filters", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", - "lineNumber": 37 - }, "signature": [ "{ input: ", { @@ -13335,19 +14927,23 @@ "text": "Query" }, "; label: string; }[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 37 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", - "lineNumber": 36 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsGeoBounds", "type": "Interface", + "tags": [], "label": "AggParamsGeoBounds", + "description": [], "signature": [ { "pluginId": "data", @@ -13359,31 +14955,35 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoBounds.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", "lineNumber": 17 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsGeoCentroid", "type": "Interface", + "tags": [], "label": "AggParamsGeoCentroid", + "description": [], "signature": [ { "pluginId": "data", @@ -13395,31 +14995,35 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoCentroid.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", "lineNumber": 17 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsGeoHash", "type": "Interface", + "tags": [], "label": "AggParamsGeoHash", + "description": [], "signature": [ { "pluginId": "data", @@ -13431,101 +15035,115 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 29 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.autoPrecision", "type": "CompoundType", + "tags": [], "label": "autoPrecision", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 30 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.precision", "type": "number", + "tags": [], "label": "precision", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 31 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.useGeocentroid", "type": "CompoundType", + "tags": [], "label": "useGeocentroid", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 32 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.isFilteredByCollar", "type": "CompoundType", + "tags": [], "label": "isFilteredByCollar", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 33 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.boundingBox", "type": "CompoundType", + "tags": [], "label": "boundingBox", "description": [], + "signature": [ + "Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 34 }, - "signature": [ - "Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsGeoTile", "type": "Interface", + "tags": [], "label": "AggParamsGeoTile", + "description": [], "signature": [ { "pluginId": "data", @@ -13537,59 +15155,67 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoTile.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoTile.useGeocentroid", "type": "CompoundType", + "tags": [], "label": "useGeocentroid", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "lineNumber": 25 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsGeoTile.precision", "type": "number", + "tags": [], "label": "precision", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "lineNumber": 26 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsHistogram", "type": "Interface", + "tags": [], "label": "AggParamsHistogram", + "description": [], "signature": [ { "pluginId": "data", @@ -13601,130 +15227,148 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsHistogram.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 41 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsHistogram.interval", "type": "CompoundType", + "tags": [], "label": "interval", "description": [], + "signature": [ + "React.ReactText" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 42 }, - "signature": [ - "React.ReactText" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsHistogram.used_interval", "type": "CompoundType", + "tags": [], "label": "used_interval", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 43 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsHistogram.maxBars", "type": "number", + "tags": [], "label": "maxBars", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 44 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsHistogram.intervalBase", "type": "number", + "tags": [], "label": "intervalBase", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 45 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsHistogram.min_doc_count", "type": "CompoundType", + "tags": [], "label": "min_doc_count", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 46 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsHistogram.has_extended_bounds", "type": "CompoundType", + "tags": [], "label": "has_extended_bounds", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 47 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsHistogram.extended_bounds", "type": "Object", + "tags": [], "label": "extended_bounds", "description": [], + "signature": [ + "ExtendedBounds", + " | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 48 }, - "signature": [ - "ExtendedBounds", - " | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "lineNumber": 40 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsIpRange", "type": "Interface", + "tags": [], "label": "AggParamsIpRange", + "description": [], "signature": [ { "pluginId": "data", @@ -13736,30 +15380,32 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsIpRange.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsIpRange.ipRangeType", "type": "CompoundType", + "tags": [], "label": "ipRangeType", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", - "lineNumber": 31 - }, "signature": [ { "pluginId": "data", @@ -13769,18 +15415,20 @@ "text": "IP_RANGE_TYPES" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 31 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsIpRange.ranges", "type": "Object", + "tags": [], "label": "ranges", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", - "lineNumber": 32 - }, "signature": [ "Partial<{ fromTo: ", { @@ -13799,19 +15447,23 @@ "text": "CidrMaskIpRangeAggKey" }, "[]; }> | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 32 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsMax", "type": "Interface", + "tags": [], "label": "AggParamsMax", + "description": [], "signature": [ { "pluginId": "data", @@ -13823,31 +15475,35 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/max.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsMax.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/max.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/max.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsMedian", "type": "Interface", + "tags": [], "label": "AggParamsMedian", + "description": [], "signature": [ { "pluginId": "data", @@ -13859,31 +15515,35 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/median.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsMedian.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/median.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/median.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsMin", "type": "Interface", + "tags": [], "label": "AggParamsMin", + "description": [], "signature": [ { "pluginId": "data", @@ -13895,31 +15555,35 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/min.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsMin.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/min.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/min.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg", "type": "Interface", + "tags": [], "label": "AggParamsMovingAvg", + "description": [], "signature": [ { "pluginId": "data", @@ -13931,92 +15595,104 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg.buckets_path", "type": "string", + "tags": [], "label": "buckets_path", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg.window", "type": "number", + "tags": [], "label": "window", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 19 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg.script", "type": "string", + "tags": [], "label": "script", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg.customMetric", "type": "Object", + "tags": [], "label": "customMetric", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", - "lineNumber": 21 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg.metricAgg", "type": "string", + "tags": [], "label": "metricAgg", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 22 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsPercentileRanks", "type": "Interface", + "tags": [], "label": "AggParamsPercentileRanks", + "description": [], "signature": [ { "pluginId": "data", @@ -14028,45 +15704,51 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsPercentileRanks.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsPercentileRanks.values", "type": "Array", + "tags": [], "label": "values", "description": [], + "signature": [ + "number[] | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 23 }, - "signature": [ - "number[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsPercentiles", "type": "Interface", + "tags": [], "label": "AggParamsPercentiles", + "description": [], "signature": [ { "pluginId": "data", @@ -14078,45 +15760,51 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsPercentiles.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsPercentiles.percents", "type": "Array", + "tags": [], "label": "percents", "description": [], + "signature": [ + "number[] | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "lineNumber": 21 }, - "signature": [ - "number[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsRange", "type": "Interface", + "tags": [], "label": "AggParamsRange", + "description": [], "signature": [ { "pluginId": "data", @@ -14128,45 +15816,51 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsRange.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsRange.ranges", "type": "Array", + "tags": [], "label": "ranges", "description": [], + "signature": [ + "{ from: number; to: number; label?: string | undefined; }[] | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 31 }, - "signature": [ - "{ from: number; to: number; label?: string | undefined; }[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/range.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsSerialDiff", "type": "Interface", + "tags": [], "label": "AggParamsSerialDiff", + "description": [], "signature": [ { "pluginId": "data", @@ -14178,64 +15872,72 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsSerialDiff.buckets_path", "type": "string", + "tags": [], "label": "buckets_path", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsSerialDiff.customMetric", "type": "Object", + "tags": [], "label": "customMetric", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", - "lineNumber": 19 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsSerialDiff.metricAgg", "type": "string", + "tags": [], "label": "metricAgg", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsSignificantTerms", "type": "Interface", + "tags": [], "label": "AggParamsSignificantTerms", + "description": [], "signature": [ { "pluginId": "data", @@ -14247,73 +15949,83 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsSignificantTerms.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsSignificantTerms.size", "type": "number", + "tags": [], "label": "size", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 24 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsSignificantTerms.exclude", "type": "string", + "tags": [], "label": "exclude", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 25 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsSignificantTerms.include", "type": "string", + "tags": [], "label": "include", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 26 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsSinglePercentile", "type": "Interface", + "tags": [], "label": "AggParamsSinglePercentile", + "description": [], "signature": [ { "pluginId": "data", @@ -14325,42 +16037,48 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsSinglePercentile.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsSinglePercentile.percentile", "type": "number", + "tags": [], "label": "percentile", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", "lineNumber": 22 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsStdDeviation", "type": "Interface", + "tags": [], "label": "AggParamsStdDeviation", + "description": [], "signature": [ { "pluginId": "data", @@ -14372,31 +16090,35 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsStdDeviation.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 19 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsSum", "type": "Interface", + "tags": [], "label": "AggParamsSum", + "description": [], "signature": [ { "pluginId": "data", @@ -14408,31 +16130,35 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsSum.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsTerms", "type": "Interface", + "tags": [], "label": "AggParamsTerms", + "description": [], "signature": [ { "pluginId": "data", @@ -14444,170 +16170,194 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 51 - } + "lineNumber": 49 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.orderBy", "type": "string", + "tags": [], "label": "orderBy", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 52 - } + "lineNumber": 50 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.orderAgg", "type": "Object", + "tags": [], "label": "orderAgg", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 53 - }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", "SerializableState", " | undefined; schema?: string | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.order", "type": "CompoundType", + "tags": [], "label": "order", "description": [], + "signature": [ + "\"asc\" | \"desc\" | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 54 + "lineNumber": 52 }, - "signature": [ - "\"asc\" | \"desc\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.size", "type": "number", + "tags": [], "label": "size", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 55 + "lineNumber": 53 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.missingBucket", "type": "CompoundType", + "tags": [], "label": "missingBucket", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 56 + "lineNumber": 54 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.missingBucketLabel", "type": "string", + "tags": [], "label": "missingBucketLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 57 + "lineNumber": 55 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.otherBucket", "type": "CompoundType", + "tags": [], "label": "otherBucket", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 58 + "lineNumber": 56 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.otherBucketLabel", "type": "string", + "tags": [], "label": "otherBucketLabel", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 59 + "lineNumber": 57 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.exclude", "type": "string", + "tags": [], "label": "exclude", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 61 + "lineNumber": 59 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.include", "type": "string", + "tags": [], "label": "include", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 62 - }, "signature": [ "string | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 60 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 50 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsTopHit", "type": "Interface", + "tags": [], "label": "AggParamsTopHit", + "description": [], "signature": [ { "pluginId": "data", @@ -14619,87 +16369,99 @@ " extends ", "BaseAggParams" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTopHit.field", "type": "string", + "tags": [], "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTopHit.aggregate", "type": "CompoundType", + "tags": [], "label": "aggregate", "description": [], + "signature": [ + "\"max\" | \"min\" | \"concat\" | \"sum\" | \"average\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 19 }, - "signature": [ - "\"max\" | \"min\" | \"concat\" | \"sum\" | \"average\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTopHit.sortField", "type": "string", + "tags": [], "label": "sortField", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTopHit.size", "type": "number", + "tags": [], "label": "size", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 21 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTopHit.sortOrder", "type": "CompoundType", + "tags": [], "label": "sortOrder", "description": [], + "signature": [ + "\"asc\" | \"desc\" | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 22 }, - "signature": [ - "\"asc\" | \"desc\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggTypeConfig", "type": "Interface", + "tags": [], "label": "AggTypeConfig", + "description": [], "signature": [ { "pluginId": "data", @@ -14710,286 +16472,298 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 26 - } + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 27 - } + "lineNumber": 38 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.createFilter", "type": "Function", + "tags": [], "label": "createFilter", "description": [], + "signature": [ + "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 28 + "lineNumber": 39 }, - "signature": [ - "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 29 + "lineNumber": 40 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.dslName", "type": "string", + "tags": [], "label": "dslName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 30 + "lineNumber": 41 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.expressionName", "type": "string", + "tags": [], "label": "expressionName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 31 - } + "lineNumber": 42 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.makeLabel", "type": "CompoundType", + "tags": [], "label": "makeLabel", "description": [], + "signature": [ + "((aggConfig: TAggConfig) => string) | (() => string) | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 32 + "lineNumber": 43 }, - "signature": [ - "((aggConfig: TAggConfig) => string) | (() => string) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.ordered", "type": "Any", + "tags": [], "label": "ordered", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 33 + "lineNumber": 44 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.hasNoDsl", "type": "CompoundType", + "tags": [], "label": "hasNoDsl", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 34 + "lineNumber": 45 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.hasNoDslParams", "type": "CompoundType", + "tags": [], "label": "hasNoDslParams", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 35 + "lineNumber": 46 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.params", "type": "Array", + "tags": [], "label": "params", "description": [], + "signature": [ + "Partial[] | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 36 + "lineNumber": 47 }, - "signature": [ - "Partial[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.valueType", "type": "CompoundType", + "tags": [], "label": "valueType", "description": [], + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 37 + "lineNumber": 48 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.getRequestAggs", "type": "CompoundType", + "tags": [], "label": "getRequestAggs", "description": [], + "signature": [ + "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 38 + "lineNumber": 49 }, - "signature": [ - "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.getResponseAggs", "type": "CompoundType", + "tags": [], "label": "getResponseAggs", "description": [], + "signature": [ + "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 39 + "lineNumber": 50 }, - "signature": [ - "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.customLabels", "type": "CompoundType", + "tags": [], "label": "customLabels", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 40 + "lineNumber": 51 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.json", "type": "CompoundType", + "tags": [], "label": "json", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 41 + "lineNumber": 52 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.decorateAggConfig", "type": "Function", + "tags": [], "label": "decorateAggConfig", "description": [], + "signature": [ + "(() => any) | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 42 + "lineNumber": 53 }, - "signature": [ - "(() => any) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.postFlightRequest", "type": "Function", + "tags": [], "label": "postFlightRequest", "description": [], + "signature": [ + "PostFlightRequestFn | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 43 + "lineNumber": 54 }, - "signature": [ - "((resp: any, aggConfigs: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - ", aggConfig: TAggConfig, searchSource: Pick<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, inspectorRequestAdapter?: ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestAdapter", - "text": "RequestAdapter" - }, - " | undefined, abortSignal?: AbortSignal | undefined, searchSessionId?: string | undefined) => Promise) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.getSerializedFormat", "type": "Function", + "tags": [], "label": "getSerializedFormat", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 52 - }, "signature": [ "((agg: TAggConfig) => ", { @@ -15000,97 +16774,113 @@ "text": "SerializedFieldFormat" }, ">) | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.getValue", "type": "Function", + "tags": [], "label": "getValue", "description": [], + "signature": [ + "((agg: TAggConfig, bucket: any) => any) | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 53 + "lineNumber": 56 }, - "signature": [ - "((agg: TAggConfig, bucket: any) => any) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.getKey", "type": "Function", + "tags": [], "label": "getKey", "description": [], + "signature": [ + "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 54 + "lineNumber": 57 }, - "signature": [ - "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggTypeConfig.getValueBucketPath", "type": "Function", + "tags": [], "label": "getValueBucketPath", "description": [], + "signature": [ + "((agg: TAggConfig) => string) | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 55 + "lineNumber": 58 }, - "signature": [ - "((agg: TAggConfig) => string) | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AutoBounds", "type": "Interface", + "tags": [], "label": "AutoBounds", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AutoBounds.min", "type": "number", + "tags": [], "label": "min", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 26 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AutoBounds.max", "type": "number", + "tags": [], "label": "max", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 27 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.BucketAggParam", "type": "Interface", + "tags": [], "label": "BucketAggParam", + "description": [], "signature": [ { "pluginId": "data", @@ -15109,33 +16899,35 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.BucketAggParam.scriptable", "type": "CompoundType", + "tags": [], "label": "scriptable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 20 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.BucketAggParam.filterFieldTypes", "type": "CompoundType", + "tags": [], "label": "filterFieldTypes", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 21 - }, "signature": [ { "pluginId": "data", @@ -15153,198 +16945,287 @@ "text": "KBN_FIELD_TYPES" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 21 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.CidrMaskIpRangeAggKey", "type": "Interface", + "tags": [], "label": "CidrMaskIpRangeAggKey", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.CidrMaskIpRangeAggKey.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"mask\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 10 }, - "signature": [ - "\"mask\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.CidrMaskIpRangeAggKey.mask", "type": "string", + "tags": [], "label": "mask", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 11 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.DateHistogramBucketAggDependencies", "type": "Interface", + "tags": [], "label": "DateHistogramBucketAggDependencies", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.DateHistogramBucketAggDependencies.calculateBounds", "type": "Function", + "tags": [], "label": "calculateBounds", "description": [], + "signature": [ + "CalculateBoundsFn" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 48 }, - "signature": [ - "CalculateBoundsFn" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DateHistogramBucketAggDependencies.isDefaultTimezone", "type": "Function", + "tags": [], "label": "isDefaultTimezone", "description": [], + "signature": [ + "() => boolean" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 49 }, - "signature": [ - "() => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DateHistogramBucketAggDependencies.getConfig", "type": "Function", + "tags": [], "label": "getConfig", "description": [], + "signature": [ + "(key: string) => T" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 50 }, - "signature": [ - "(key: string) => T" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 47 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.DateRangeBucketAggDependencies", "type": "Interface", + "tags": [], "label": "DateRangeBucketAggDependencies", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.DateRangeBucketAggDependencies.isDefaultTimezone", "type": "Function", + "tags": [], "label": "isDefaultTimezone", "description": [], + "signature": [ + "() => boolean" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 27 }, - "signature": [ - "() => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DateRangeBucketAggDependencies.getConfig", "type": "Function", + "tags": [], "label": "getConfig", "description": [], + "signature": [ + "(key: string) => T" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 28 }, - "signature": [ - "(key: string) => T" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.DateRangeKey", "type": "Interface", + "tags": [], "label": "DateRangeKey", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.DateRangeKey.from", "type": "CompoundType", + "tags": [], "label": "from", "description": [], + "signature": [ + "React.ReactText" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "lineNumber": 10 }, - "signature": [ - "React.ReactText" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.DateRangeKey.to", "type": "CompoundType", + "tags": [], "label": "to", "description": [], + "signature": [ + "React.ReactText" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "lineNumber": 11 }, - "signature": [ - "React.ReactText" - ] + "deprecated": false } ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.EqlSearchStrategyRequest", + "type": "Interface", + "tags": [], + "label": "EqlSearchStrategyRequest", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EqlSearchStrategyRequest", + "text": "EqlSearchStrategyRequest" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EqlRequestParams", + "text": "EqlRequestParams" + }, + ">" + ], "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", - "lineNumber": 9 + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 18 }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.EqlSearchStrategyRequest.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "TransportRequestOptions", + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 19 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.EsRawResponse", "type": "Interface", + "tags": [], "label": "EsRawResponse", + "description": [], "signature": [ { "pluginId": "data", @@ -15355,62 +17236,68 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.EsRawResponse.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"es_raw_response\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "lineNumber": 15 }, - "signature": [ - "\"es_raw_response\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.EsRawResponse.body", "type": "Object", + "tags": [], "label": "body", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", - "lineNumber": 16 - }, "signature": [ "SearchResponse", "" - ] + ], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 16 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FetchHandlers", "type": "Interface", + "tags": [], "label": "FetchHandlers", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FetchHandlers.getConfig", "type": "Function", + "tags": [], "label": "getConfig", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 23 - }, "signature": [ { "pluginId": "data", @@ -15419,116 +17306,118 @@ "section": "def-common.GetConfigFn", "text": "GetConfigFn" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 22 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.FetchHandlers.onResponse", "type": "Function", + "tags": [], "label": "onResponse", "description": [ "\nCallback which can be used to hook into responses, modify them, or perform\nside effects like displaying UI errors on the client." ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 28 - }, "signature": [ "(request: Record, response: ", - "SearchResponse", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, ") => ", - "SearchResponse", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, "" - ] - }, - { - "tags": [], - "id": "def-common.FetchHandlers.legacy", - "type": "Object", - "label": "legacy", - "description": [ - "\nThese handlers are only used by the legacy defaultSearchStrategy and can be removed\nonce that strategy has been deprecated." ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 36 + "lineNumber": 27 }, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.LegacyFetchHandlers", - "text": "LegacyFetchHandlers" - } - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FiltersBucketAggDependencies", "type": "Interface", + "tags": [], "label": "FiltersBucketAggDependencies", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.FiltersBucketAggDependencies.getConfig", "type": "Function", + "tags": [], "label": "getConfig", "description": [], + "signature": [ + "(key: string) => any" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "lineNumber": 33 }, - "signature": [ - "(key: string) => any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", - "lineNumber": 32 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.HistogramBucketAggDependencies", "type": "Interface", + "tags": [], "label": "HistogramBucketAggDependencies", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.HistogramBucketAggDependencies.getConfig", "type": "Function", + "tags": [], "label": "getConfig", "description": [], + "signature": [ + "(key: string) => T" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 31 }, - "signature": [ - "(key: string) => T" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.HistogramBucketAggDependencies.getFieldFormatsStart", "type": "Function", + "tags": [], "label": "getFieldFormatsStart", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "lineNumber": 32 - }, "signature": [ "() => Pick, \"deserialize\" | \"getDefaultInstance\">" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 32 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.IAsyncSearchOptions", + "type": "Interface", + "tags": [], + "label": "IAsyncSearchOptions", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAsyncSearchOptions", + "text": "IAsyncSearchOptions" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" } ], "source": { - "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "lineNumber": 30 + "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", + "lineNumber": 13 }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.IAsyncSearchOptions.pollInterval", + "type": "number", + "tags": [], + "label": "pollInterval", + "description": [ + "\nThe number of milliseconds to wait between receiving a response and sending another request" + ], + "signature": [ + "number | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", + "lineNumber": 17 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IBucketAggConfig", "type": "Interface", + "tags": [], "label": "IBucketAggConfig", + "description": [], "signature": [ { "pluginId": "data", @@ -15569,19 +17513,19 @@ "text": "AggConfig" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IBucketAggConfig.type", "type": "Object", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 15 - }, "signature": [ { "pluginId": "data", @@ -15599,19 +17543,23 @@ "text": "AggConfig" }, ">" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 15 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IBucketDateHistogramAggConfig", "type": "Interface", + "tags": [], "label": "IBucketDateHistogramAggConfig", + "description": [], "signature": [ { "pluginId": "data", @@ -15629,34 +17577,38 @@ "text": "IBucketAggConfig" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IBucketDateHistogramAggConfig.buckets", "type": "Object", + "tags": [], "label": "buckets", "description": [], + "signature": [ + "TimeBuckets" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 54 }, - "signature": [ - "TimeBuckets" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IBucketHistogramAggConfig", "type": "Interface", + "tags": [], "label": "IBucketHistogramAggConfig", + "description": [], "signature": [ { "pluginId": "data", @@ -15674,19 +17626,19 @@ "text": "IBucketAggConfig" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IBucketHistogramAggConfig.setAutoBounds", "type": "Function", + "tags": [], "label": "setAutoBounds", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "lineNumber": 36 - }, "signature": [ "(bounds: ", { @@ -15697,18 +17649,20 @@ "text": "AutoBounds" }, ") => void" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 36 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IBucketHistogramAggConfig.getAutoBounds", "type": "Function", + "tags": [], "label": "getAutoBounds", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "lineNumber": 37 - }, "signature": [ "() => ", { @@ -15718,19 +17672,23 @@ "section": "def-common.AutoBounds", "text": "AutoBounds" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 37 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IEsSearchRequest", "type": "Interface", + "tags": [], "label": "IEsSearchRequest", + "description": [], "signature": [ { "pluginId": "data", @@ -15757,37 +17715,125 @@ }, ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IEsSearchRequest.indexType", "type": "string", + "tags": [], "label": "indexType", "description": [], + "signature": [ + "string | undefined" + ], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { - "id": "def-common.IKibanaSearchRequest", + "parentPluginId": "data", + "id": "def-common.IInspectorInfo", "type": "Interface", - "label": "IKibanaSearchRequest", - "signature": [ - { - "pluginId": "data", + "tags": [], + "label": "IInspectorInfo", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 83 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.IInspectorInfo.adapter", + "type": "Object", + "tags": [], + "label": "adapter", + "description": [], + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 84 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.IInspectorInfo.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 85 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.IInspectorInfo.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 86 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.IInspectorInfo.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 87 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.IKibanaSearchRequest", + "type": "Interface", + "tags": [], + "label": "IKibanaSearchRequest", + "description": [], + "signature": [ + { + "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchRequest", @@ -15795,50 +17841,56 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IKibanaSearchRequest.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nAn id can be used to uniquely identify this request." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 78 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IKibanaSearchRequest.params", "type": "Uncategorized", + "tags": [], "label": "params", "description": [], + "signature": [ + "Params | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 80 }, - "signature": [ - "Params | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 74 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse", "type": "Interface", + "tags": [], "label": "IKibanaSearchResponse", + "description": [], "signature": [ { "pluginId": "data", @@ -15849,116 +17901,130 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 44 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.total", "type": "number", + "tags": [], "label": "total", "description": [ "\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 50 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.loaded", "type": "number", + "tags": [], "label": "loaded", "description": [ "\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 56 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.isRunning", "type": "CompoundType", + "tags": [], "label": "isRunning", "description": [ "\nIndicates whether search is still in flight" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 61 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.isPartial", "type": "CompoundType", + "tags": [], "label": "isPartial", "description": [ "\nIndicates whether the results returned are complete or partial" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 66 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.rawResponse", "type": "Uncategorized", + "tags": [], "label": "rawResponse", "description": [ "\nThe raw response returned by the internal search method (usually the raw ES response)" ], + "signature": [ + "RawResponse" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 71 }, - "signature": [ - "RawResponse" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 40 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IMetricAggConfig", "type": "Interface", + "tags": [], "label": "IMetricAggConfig", + "description": [], "signature": [ { "pluginId": "data", @@ -15976,19 +18042,19 @@ "text": "AggConfig" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IMetricAggConfig.type", "type": "Object", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 17 - }, "signature": [ { "pluginId": "data", @@ -16006,32 +18072,36 @@ "text": "AggConfig" }, ">" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 17 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ISearchClient", "type": "Interface", + "tags": [], "label": "ISearchClient", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.ISearchClient.search", "type": "Function", + "tags": [], "label": "search", "description": [], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 29 - }, "signature": [ { "pluginId": "data", @@ -16040,20 +18110,22 @@ "section": "def-common.ISearchGeneric", "text": "ISearchGeneric" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ISearchClient.cancel", "type": "Function", + "tags": [], "label": "cancel", "description": [ "\nUsed to cancel an in-progress search request." ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 33 - }, "signature": [ { "pluginId": "data", @@ -16062,20 +18134,22 @@ "section": "def-common.ISearchCancelGeneric", "text": "ISearchCancelGeneric" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ISearchClient.extend", "type": "Function", + "tags": [], "label": "extend", "description": [ "\nUsed to extend the TTL of an in-progress search request." ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 37 - }, "signature": [ { "pluginId": "data", @@ -16084,130 +18158,146 @@ "section": "def-common.ISearchExtendGeneric", "text": "ISearchExtendGeneric" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 37 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ISearchOptions", "type": "Interface", + "tags": [], "label": "ISearchOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 90 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.ISearchOptions.abortSignal", "type": "Object", + "tags": [], "label": "abortSignal", "description": [ "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." ], + "signature": [ + "AbortSignal | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 87 + "lineNumber": 94 }, - "signature": [ - "AbortSignal | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 92 + "lineNumber": 99 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.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`." ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 98 - }, "signature": [ "boolean | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 105 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ISearchOptions.sessionId", "type": "string", + "tags": [], "label": "sessionId", "description": [ "\nA session ID, grouping multiple search requests into a single session." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 103 + "lineNumber": 110 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ISearchOptions.isStored", "type": "CompoundType", + "tags": [], "label": "isStored", "description": [ "\nWhether the session is already saved (i.e. sent to background)" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 108 + "lineNumber": 115 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.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" + ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 114 + "lineNumber": 121 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ISearchOptions.indexPattern", "type": "Object", + "tags": [], "label": "indexPattern", "description": [ "\nIndex pattern reference is used for better error messages" ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 120 - }, "signature": [ { "pluginId": "data", @@ -16217,38 +18307,65 @@ "text": "IndexPattern" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 126 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.ISearchOptions.inspector", + "type": "Object", + "tags": [], + "label": "inspector", + "description": [ + "\nInspector integration options" + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IInspectorInfo", + "text": "IInspectorInfo" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 131 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 83 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ISearchStartSearchSource", "type": "Interface", + "tags": [], "label": "ISearchStartSearchSource", "description": [ "\nhigh level search service" ], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.ISearchStartSearchSource.create", "type": "Function", + "tags": [], "label": "create", "description": [ "\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 30 - }, "signature": [ "(fields?: ", { @@ -16267,20 +18384,22 @@ "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">>" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 31 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ISearchStartSearchSource.createEmpty", "type": "Function", + "tags": [], "label": "createEmpty", "description": [ "\ncreates empty {@link SearchSource}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 34 - }, "signature": [ "() => Pick<", { @@ -16291,19 +18410,23 @@ "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 35 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IStdDevAggConfig", "type": "Interface", + "tags": [], "label": "IStdDevAggConfig", + "description": [], "signature": [ { "pluginId": "data", @@ -16315,107 +18438,54 @@ " extends ", "IResponseAggConfig" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IStdDevAggConfig.keyedDetails", "type": "Function", + "tags": [], "label": "keyedDetails", "description": [], + "signature": [ + "(customLabel: string, fieldDisplayName?: string | undefined) => Record" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 28 }, - "signature": [ - "(customLabel: string, fieldDisplayName?: string | undefined) => Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.IStdDevAggConfig.valProp", "type": "Function", + "tags": [], "label": "valProp", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", - "lineNumber": 29 - }, "signature": [ "() => string[]" - ] - } - ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", - "lineNumber": 27 - }, - "initialIsOpen": false - }, - { - "id": "def-common.LegacyFetchHandlers", - "type": "Interface", - "label": "LegacyFetchHandlers", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.LegacyFetchHandlers.callMsearch", - "type": "Function", - "label": "callMsearch", - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 35 - }, - "signature": [ - "(params: { body: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.MsearchRequestBody", - "text": "MsearchRequestBody" - }, - "; signal: AbortSignal; }) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.MsearchResponse", - "text": "MsearchResponse" - }, - ">" - ] - }, - { - "tags": [], - "id": "def-common.LegacyFetchHandlers.loadingCount$", - "type": "Object", - "label": "loadingCount$", - "description": [], + ], "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 39 + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 29 }, - "signature": [ - "BehaviorSubject", - "" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.MetricAggParam", "type": "Interface", + "tags": [], "label": "MetricAggParam", + "description": [], "signature": [ { "pluginId": "data", @@ -16434,19 +18504,19 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.MetricAggParam.filterFieldTypes", "type": "CompoundType", + "tags": [], "label": "filterFieldTypes", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 22 - }, "signature": [ { "pluginId": "data", @@ -16464,141 +18534,161 @@ "text": "KBN_FIELD_TYPES" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 22 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.MetricAggParam.onlyAggregatable", "type": "CompoundType", + "tags": [], "label": "onlyAggregatable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 23 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.MsearchRequestBody", "type": "Interface", + "tags": [], "label": "MsearchRequestBody", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.MsearchRequestBody.searches", "type": "Array", + "tags": [], "label": "searches", "description": [], + "signature": [ + "MsearchRequest[]" + ], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 25 + "lineNumber": 23 }, - "signature": [ - "MsearchRequest[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.MsearchResponse", "type": "Interface", + "tags": [], "label": "MsearchResponse", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.MsearchResponse.body", "type": "Object", + "tags": [], "label": "body", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 30 - }, "signature": [ "ApiResponse", "<{ responses: ", "SearchResponse", "[]; }, unknown>" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 28 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.OptionedValueProp", "type": "Interface", + "tags": [], "label": "OptionedValueProp", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.OptionedValueProp.value", "type": "string", + "tags": [], "label": "value", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.OptionedValueProp.text", "type": "string", + "tags": [], "label": "text", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.OptionedValueProp.disabled", "type": "CompoundType", + "tags": [], "label": "disabled", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 15 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.OptionedValueProp.isCompatible", "type": "Function", + "tags": [], "label": "isCompatible", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 16 - }, "signature": [ "(agg: ", { @@ -16609,32 +18699,36 @@ "text": "AggConfig" }, ") => boolean" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.PercentileRanksMetricAggDependencies", "type": "Interface", + "tags": [], "label": "PercentileRanksMetricAggDependencies", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.PercentileRanksMetricAggDependencies.getFieldFormatsStart", "type": "Function", + "tags": [], "label": "getFieldFormatsStart", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", - "lineNumber": 30 - }, "signature": [ "() => Pick, \"deserialize\" | \"getDefaultInstance\">" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 30 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.RangeBucketAggDependencies", "type": "Interface", + "tags": [], "label": "RangeBucketAggDependencies", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeBucketAggDependencies.getFieldFormatsStart", "type": "Function", + "tags": [], "label": "getFieldFormatsStart", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/range.ts", - "lineNumber": 26 - }, "signature": [ "() => Pick, \"deserialize\" | \"getDefaultInstance\">" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 26 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/range.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.RangeIpRangeAggKey", "type": "Interface", + "tags": [], "label": "RangeIpRangeAggKey", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeIpRangeAggKey.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"range\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 15 }, - "signature": [ - "\"range\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeIpRangeAggKey.from", "type": "string", + "tags": [], "label": "from", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.RangeIpRangeAggKey.to", "type": "string", + "tags": [], "label": "to", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 17 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.Request", "type": "Interface", + "tags": [], "label": "Request", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 131 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.Request.docvalue_fields", "type": "Array", + "tags": [], "label": "docvalue_fields", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 123 + "lineNumber": 132 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.Request._source", "type": "Unknown", + "tags": [], "label": "_source", "description": [], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 124 + "lineNumber": 133 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.Request.query", "type": "Unknown", + "tags": [], "label": "query", "description": [], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 125 + "lineNumber": 134 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.Request.script_fields", "type": "Unknown", + "tags": [], "label": "script_fields", "description": [], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 126 + "lineNumber": 135 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.Request.sort", "type": "Unknown", + "tags": [], "label": "sort", "description": [], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 127 + "lineNumber": 136 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.Request.stored_fields", "type": "Array", + "tags": [], "label": "stored_fields", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 128 + "lineNumber": 137 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 122 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ResponseWithShardFailure", "type": "Interface", + "tags": [], "label": "ResponseWithShardFailure", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 140 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.ResponseWithShardFailure._shards", "type": "Object", + "tags": [], "label": "_shards", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 132 - }, "signature": [ "{ failed: number; failures: ", { @@ -16865,190 +18989,224 @@ "text": "ShardFailure" }, "[]; skipped: number; successful: number; total: number; }" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 141 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 131 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchError", "type": "Interface", + "tags": [], "label": "SearchError", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchError.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 40 - } + "lineNumber": 31 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchError.status", "type": "string", + "tags": [], "label": "status", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 41 - } + "lineNumber": 32 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchError.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 42 - } + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchError.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 43 - } + "lineNumber": 34 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchError.path", "type": "string", + "tags": [], "label": "path", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 44 - } + "lineNumber": 35 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchError.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 45 - } + "lineNumber": 36 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 39 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions", "type": "Interface", + "tags": [], "label": "SearchSessionFindOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/session/types.ts", + "lineNumber": 95 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions.page", "type": "number", + "tags": [], "label": "page", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 96 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 97 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions.sortField", "type": "string", + "tags": [], "label": "sortField", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 98 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions.sortOrder", "type": "string", + "tags": [], "label": "sortOrder", "description": [], - "source": { + "signature": [ + "string | undefined" + ], + "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 99 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions.filter", "type": "string", + "tags": [], "label": "filter", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 100 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 95 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchSessionRequestInfo", "type": "Interface", + "tags": [], "label": "SearchSessionRequestInfo", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/session/types.ts", + "lineNumber": 76 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionRequestInfo.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nID of the async search request" @@ -17056,12 +19214,14 @@ "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 80 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionRequestInfo.strategy", "type": "string", + "tags": [], "label": "strategy", "description": [ "\nSearch strategy used to submit the search request" @@ -17069,12 +19229,14 @@ "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 84 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionRequestInfo.status", "type": "string", + "tags": [], "label": "status", "description": [ "\nstatus" @@ -17082,85 +19244,97 @@ "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 88 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionRequestInfo.error", "type": "string", + "tags": [], "label": "error", "description": [ "\nAn optional error. Set if status is set to error." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 92 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 76 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes", "type": "Interface", + "tags": [], "label": "SearchSessionSavedObjectAttributes", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/session/types.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.sessionId", "type": "string", + "tags": [], "label": "sessionId", "description": [], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nUser-facing session name to be displayed in session management" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 17 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.appId", "type": "string", + "tags": [], "label": "appId", "description": [ "\nApp that created the session. e.g 'discover'" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.created", "type": "string", + "tags": [], "label": "created", "description": [ "\nCreation time of the session" @@ -17168,12 +19342,14 @@ "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.touched", "type": "string", + "tags": [], "label": "touched", "description": [ "\nLast touch time of the session" @@ -17181,12 +19357,14 @@ "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 29 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.expires", "type": "string", + "tags": [], "label": "expires", "description": [ "\nExpiration time of the session. Expiration itself is managed by Elasticsearch." @@ -17194,36 +19372,36 @@ "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.completed", "type": "CompoundType", + "tags": [], "label": "completed", "description": [ "\nTime of transition into completed state,\n\nCan be \"null\" in case already completed session\ntransitioned into in-progress session" ], + "signature": [ + "string | null | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 40 }, - "signature": [ - "string | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.status", "type": "Enum", + "tags": [], "label": "status", "description": [ "\nstatus" ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 44 - }, "signature": [ { "pluginId": "data", @@ -17232,68 +19410,76 @@ "section": "def-common.SearchSessionStatus", "text": "SearchSessionStatus" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/session/types.ts", + "lineNumber": 44 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.urlGeneratorId", "type": "string", + "tags": [], "label": "urlGeneratorId", "description": [ "\nurlGeneratorId" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 48 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.initialState", "type": "Object", + "tags": [], "label": "initialState", "description": [ "\nThe application state that was used to create the session.\nShould be used, for example, to re-load an expired search session." ], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 53 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.restoreState", "type": "Object", + "tags": [], "label": "restoreState", "description": [ "\nApplication state that should be used to restore the session.\nFor example, relative dates are conveted to absolute ones." ], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 58 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.idMapping", "type": "Object", + "tags": [], "label": "idMapping", "description": [ "\nMapping of search request hashes to their corresponsing info (async search id, etc.)" ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 62 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/plugins/data/common/search/session/types.ts", + "lineNumber": 62 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.persisted", "type": "boolean", + "tags": [], "label": "persisted", "description": [ "\nThis value is true if the session was actively stored by the user. If it is false, the session may be purged by the system." @@ -17317,63 +19509,69 @@ "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 67 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.realmType", "type": "string", + "tags": [], "label": "realmType", "description": [ "\nThe realm type/name & username uniquely identifies the user who created this search session" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 71 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.realmName", "type": "string", + "tags": [], "label": "realmName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 72 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.username", "type": "string", + "tags": [], "label": "username", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 73 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchSourceDependencies", "type": "Interface", + "tags": [], "label": "SearchSourceDependencies", + "description": [], "signature": [ { "pluginId": "data", @@ -17391,19 +19589,19 @@ "text": "FetchHandlers" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 116 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceDependencies.search", "type": "Function", + "tags": [], "label": "search", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 99 - }, "signature": [ { "pluginId": "data", @@ -17412,50 +19610,56 @@ "section": "def-common.ISearchGeneric", "text": "ISearchGeneric" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 117 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 98 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchSourceFields", "type": "Interface", + "tags": [], "label": "SearchSourceFields", "description": [ "\nsearch source fields" ], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 62 + "lineNumber": 71 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.query", "type": "Object", + "tags": [], "label": "query", "description": [ "\n{@link Query}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 66 - }, "signature": [ { "pluginId": "data", @@ -17465,20 +19669,22 @@ "text": "Query" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 75 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.filter", "type": "CompoundType", + "tags": [], "label": "filter", "description": [ "\n{@link Filter}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 70 - }, "signature": [ { "pluginId": "data", @@ -17512,20 +19718,22 @@ "text": "Filter" }, "[] | undefined) | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 79 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.sort", "type": "CompoundType", + "tags": [], "label": "sort", "description": [ "\n{@link EsQuerySortValue}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 74 - }, "signature": [ "Record | Record[] | undefined" - ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 83 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.highlight", "type": "Any", + "tags": [], "label": "highlight", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 75 + "lineNumber": 84 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.highlightAll", "type": "CompoundType", + "tags": [], "label": "highlightAll", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 76 + "lineNumber": 85 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.trackTotalHits", "type": "CompoundType", + "tags": [], "label": "trackTotalHits", "description": [], + "signature": [ + "number | boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 77 + "lineNumber": 86 }, - "signature": [ - "number | boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.aggs", - "type": "Any", + "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" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 81 + "lineNumber": 90 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.from", "type": "number", + "tags": [], "label": "from", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 82 + "lineNumber": 91 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.size", "type": "number", + "tags": [], "label": "size", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 83 + "lineNumber": 92 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.source", "type": "CompoundType", + "tags": [], "label": "source", "description": [], + "signature": [ + "string | boolean | string[] | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 84 + "lineNumber": 93 }, - "signature": [ - "string | boolean | string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.version", "type": "CompoundType", + "tags": [], "label": "version", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 85 + "lineNumber": 94 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.fields", "type": "Array", + "tags": [], "label": "fields", "description": [ "\nRetrieve fields via the search Fields API" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 89 - }, "signature": [ { "pluginId": "data", @@ -17697,38 +19938,58 @@ "text": "SearchFieldValue" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 98 + }, + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.SearchSourceFields.fieldsFromSource", + "type": "CompoundType", "tags": [ "deprecated" ], - "id": "def-common.SearchSourceFields.fieldsFromSource", - "type": "CompoundType", "label": "fieldsFromSource", "description": [ "\nRetreive fields directly from _source (legacy behavior)\n" ], + "signature": [ + "string | boolean | string[] | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 95 + "lineNumber": 104 }, - "signature": [ - "string | boolean | string[] | undefined" + "deprecated": true, + "references": [ + { + "plugin": "reporting", + "link": { + "path": "x-pack/plugins/reporting/server/export_types/csv_searchsource/generate_csv/generate_csv.ts", + "lineNumber": 150 + } + }, + { + "plugin": "reporting", + "link": { + "path": "x-pack/plugins/reporting/server/export_types/csv_searchsource/generate_csv/generate_csv.ts", + "lineNumber": 152 + } + } ] }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.index", "type": "Object", + "tags": [], "label": "index", "description": [ "\n{@link IndexPatternService}" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 99 - }, "signature": [ { "pluginId": "data", @@ -17738,345 +19999,271 @@ "text": "IndexPattern" }, " | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSourceFields.searchAfter", - "type": "Object", - "label": "searchAfter", - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 100 - }, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.EsQuerySearchAfter", - "text": "EsQuerySearchAfter" - }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSourceFields.timeout", - "type": "string", - "label": "timeout", - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 101 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSourceFields.terminate_after", - "type": "number", - "label": "terminate_after", - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 102 - }, - "signature": [ - "number | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchSourceFields.parent", - "type": "Object", - "label": "parent", - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 104 - }, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - " | undefined" - ] - } - ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 61 - }, - "initialIsOpen": false - }, - { - "id": "def-common.SearchSourceOptions", - "type": "Interface", - "label": "SearchSourceOptions", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.SearchSourceOptions.callParentStartHandlers", - "type": "CompoundType", - "label": "callParentStartHandlers", - "description": [], + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 108 }, - "signature": [ - "boolean | undefined" - ] - } - ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 107 - }, - "initialIsOpen": false - }, - { - "id": "def-common.SearchStrategyProvider", - "type": "Interface", - "label": "SearchStrategyProvider", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.SearchStrategyProvider.id", - "type": "string", - "label": "id", - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 48 - } + "deprecated": false }, { - "tags": [], - "id": "def-common.SearchStrategyProvider.search", - "type": "Function", - "label": "search", - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 49 - }, - "signature": [ - "(params: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchStrategySearchParams", - "text": "SearchStrategySearchParams" - }, - ") => ", + "parentPluginId": "data", + "id": "def-common.SearchSourceFields.searchAfter", + "type": "Object", + "tags": [], + "label": "searchAfter", + "description": [], + "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchStrategyResponse", - "text": "SearchStrategyResponse" + "section": "def-common.EsQuerySearchAfter", + "text": "EsQuerySearchAfter" }, - "" - ] - } - ], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 47 - }, - "initialIsOpen": false - }, - { - "id": "def-common.SearchStrategyResponse", - "type": "Interface", - "label": "SearchStrategyResponse", - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchStrategyResponse", - "text": "SearchStrategyResponse" + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 109 + }, + "deprecated": false }, - "" - ], - "description": [], - "tags": [], - "children": [ { + "parentPluginId": "data", + "id": "def-common.SearchSourceFields.timeout", + "type": "string", "tags": [], - "id": "def-common.SearchStrategyResponse.searching", - "type": "Object", - "label": "searching", + "label": "timeout", "description": [], + "signature": [ + "string | undefined" + ], "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 53 + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 110 }, - "signature": [ - "Promise<", - "SearchResponse", - "[]>" - ] + "deprecated": false }, { + "parentPluginId": "data", + "id": "def-common.SearchSourceFields.terminate_after", + "type": "number", "tags": [], - "id": "def-common.SearchStrategyResponse.abort", - "type": "Function", - "label": "abort", + "label": "terminate_after", "description": [], + "signature": [ + "number | undefined" + ], "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 54 + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 111 }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.SearchSourceFields.parent", + "type": "Object", + "tags": [], + "label": "parent", + "description": [], "signature": [ - "() => void" - ] + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 113 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 52 - }, "initialIsOpen": false }, { - "id": "def-common.SearchStrategySearchParams", + "parentPluginId": "data", + "id": "def-common.SearchSourceOptions", "type": "Interface", - "label": "SearchStrategySearchParams", - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchStrategySearchParams", - "text": "SearchStrategySearchParams" - }, - " extends ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.FetchHandlers", - "text": "FetchHandlers" - } - ], - "description": [], "tags": [], + "label": "SearchSourceOptions", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 116 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", + "id": "def-common.SearchSourceOptions.callParentStartHandlers", + "type": "CompoundType", "tags": [], - "id": "def-common.SearchStrategySearchParams.searchRequests", - "type": "Array", - "label": "searchRequests", + "label": "callParentStartHandlers", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 43 + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 117 }, - "signature": [ - "Record[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 42 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ShardFailure", "type": "Interface", + "tags": [], "label": "ShardFailure", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 150 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.ShardFailure.index", "type": "string", + "tags": [], "label": "index", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 142 - } + "lineNumber": 151 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ShardFailure.node", "type": "string", + "tags": [], "label": "node", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 143 - } + "lineNumber": 152 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ShardFailure.reason", "type": "Object", + "tags": [], "label": "reason", "description": [], + "signature": [ + "{ caused_by: { reason: string; type: string; }; reason: string; lang?: string | undefined; script?: string | undefined; script_stack?: string[] | undefined; type: string; }" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 144 + "lineNumber": 153 }, - "signature": [ - "{ caused_by: { reason: string; type: string; }; reason: string; lang?: string | undefined; script?: string | undefined; script_stack?: string[] | undefined; type: string; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ShardFailure.shard", "type": "number", + "tags": [], "label": "shard", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 155 - } + "lineNumber": 164 + }, + "deprecated": false } ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.SortDirectionFormat", + "type": "Interface", + "tags": [], + "label": "SortDirectionFormat", + "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 141 + "lineNumber": 45 }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.SortDirectionFormat.order", + "type": "Enum", + "tags": [], + "label": "order", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirection", + "text": "SortDirection" + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 46 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.SortDirectionFormat.format", + "type": "string", + "tags": [], + "label": "format", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 47 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SortDirectionNumeric", "type": "Interface", + "tags": [], "label": "SortDirectionNumeric", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortDirectionNumeric.order", "type": "Enum", + "tags": [], "label": "order", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 45 - }, "signature": [ { "pluginId": "data", @@ -18085,728 +20272,820 @@ "section": "def-common.SortDirection", "text": "SortDirection" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortDirectionNumeric.numeric_type", "type": "CompoundType", + "tags": [], "label": "numeric_type", "description": [], + "signature": [ + "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 46 + "lineNumber": 52 }, - "signature": [ - "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SortOptions", "type": "Interface", + "tags": [], "label": "SortOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 120 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortOptions.mode", "type": "CompoundType", + "tags": [], "label": "mode", "description": [], + "signature": [ + "\"max\" | \"min\" | \"sum\" | \"avg\" | \"median\" | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 112 + "lineNumber": 121 }, - "signature": [ - "\"max\" | \"min\" | \"sum\" | \"avg\" | \"median\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortOptions.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 113 + "lineNumber": 122 }, - "signature": [ - "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortOptions.nested", "type": "Uncategorized", + "tags": [], "label": "nested", "description": [], + "signature": [ + "object | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 114 + "lineNumber": 123 }, - "signature": [ - "object | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortOptions.unmapped_type", "type": "string", + "tags": [], "label": "unmapped_type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 115 + "lineNumber": 124 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortOptions.distance_type", "type": "CompoundType", + "tags": [], "label": "distance_type", "description": [], + "signature": [ + "\"arc\" | \"plane\" | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 116 + "lineNumber": 125 }, - "signature": [ - "\"arc\" | \"plane\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortOptions.unit", "type": "string", + "tags": [], "label": "unit", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 117 + "lineNumber": 126 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortOptions.ignore_unmapped", "type": "CompoundType", + "tags": [], "label": "ignore_unmapped", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 118 + "lineNumber": 127 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortOptions._script", "type": "Uncategorized", + "tags": [], "label": "_script", "description": [], + "signature": [ + "object | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 119 + "lineNumber": 128 }, - "signature": [ - "object | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 111 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "data", "id": "def-common.BUCKET_TYPES", "type": "Enum", - "label": "BUCKET_TYPES", "tags": [], + "label": "BUCKET_TYPES", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", "lineNumber": 9 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IP_RANGE_TYPES", "type": "Enum", - "label": "IP_RANGE_TYPES", "tags": [], + "label": "IP_RANGE_TYPES", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "lineNumber": 24 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.METRIC_TYPES", "type": "Enum", - "label": "METRIC_TYPES", "tags": [], + "label": "METRIC_TYPES", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", "lineNumber": 9 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchSessionStatus", "type": "Enum", - "label": "SearchSessionStatus", "tags": [], + "label": "SearchSessionStatus", "description": [], "source": { "path": "src/plugins/data/common/search/session/status.ts", "lineNumber": 9 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SortDirection", "type": "Enum", - "label": "SortDirection", "tags": [], + "label": "SortDirection", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 39 + "lineNumber": 40 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggAvgFnName", "type": "string", + "tags": [], "label": "aggAvgFnName", "description": [], + "signature": [ + "\"aggAvg\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggAvg\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggBucketAvgFnName", "type": "string", + "tags": [], "label": "aggBucketAvgFnName", "description": [], + "signature": [ + "\"aggBucketAvg\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts", "lineNumber": 14 }, - "signature": [ - "\"aggBucketAvg\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggBucketMaxFnName", "type": "string", + "tags": [], "label": "aggBucketMaxFnName", "description": [], + "signature": [ + "\"aggBucketMax\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts", "lineNumber": 14 }, - "signature": [ - "\"aggBucketMax\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggBucketMinFnName", "type": "string", + "tags": [], "label": "aggBucketMinFnName", "description": [], + "signature": [ + "\"aggBucketMin\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts", "lineNumber": 14 }, - "signature": [ - "\"aggBucketMin\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggBucketSumFnName", "type": "string", + "tags": [], "label": "aggBucketSumFnName", "description": [], + "signature": [ + "\"aggBucketSum\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts", "lineNumber": 14 }, - "signature": [ - "\"aggBucketSum\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggCardinalityFnName", "type": "string", + "tags": [], "label": "aggCardinalityFnName", "description": [], + "signature": [ + "\"aggCardinality\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggCardinality\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggConfigOptions", "type": "Type", - "label": "AggConfigOptions", "tags": [], + "label": "AggConfigOptions", "description": [], + "signature": [ + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 43 }, - "signature": [ - "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggCountFnName", "type": "string", + "tags": [], "label": "aggCountFnName", "description": [], + "signature": [ + "\"aggCount\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggCount\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggCumulativeSumFnName", "type": "string", + "tags": [], "label": "aggCumulativeSumFnName", "description": [], + "signature": [ + "\"aggCumulativeSum\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts", "lineNumber": 14 }, - "signature": [ - "\"aggCumulativeSum\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggDateHistogramFnName", "type": "string", + "tags": [], "label": "aggDateHistogramFnName", "description": [], + "signature": [ + "\"aggDateHistogram\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts", "lineNumber": 15 }, - "signature": [ - "\"aggDateHistogram\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggDateRangeFnName", "type": "string", + "tags": [], "label": "aggDateRangeFnName", "description": [], + "signature": [ + "\"aggDateRange\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts", "lineNumber": 15 }, - "signature": [ - "\"aggDateRange\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggDerivativeFnName", "type": "string", + "tags": [], "label": "aggDerivativeFnName", "description": [], + "signature": [ + "\"aggDerivative\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts", "lineNumber": 14 }, - "signature": [ - "\"aggDerivative\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggFilteredMetricFnName", "type": "string", + "tags": [], "label": "aggFilteredMetricFnName", "description": [], + "signature": [ + "\"aggFilteredMetric\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric_fn.ts", "lineNumber": 14 }, - "signature": [ - "\"aggFilteredMetric\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggFilterFnName", "type": "string", + "tags": [], "label": "aggFilterFnName", "description": [], + "signature": [ + "\"aggFilter\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts", "lineNumber": 15 }, - "signature": [ - "\"aggFilter\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggFiltersFnName", "type": "string", + "tags": [], "label": "aggFiltersFnName", "description": [], + "signature": [ + "\"aggFilters\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts", "lineNumber": 15 }, - "signature": [ - "\"aggFilters\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggGeoBoundsFnName", "type": "string", + "tags": [], "label": "aggGeoBoundsFnName", "description": [], + "signature": [ + "\"aggGeoBounds\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggGeoBounds\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggGeoCentroidFnName", "type": "string", + "tags": [], "label": "aggGeoCentroidFnName", "description": [], + "signature": [ + "\"aggGeoCentroid\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggGeoCentroid\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggGeoHashFnName", "type": "string", + "tags": [], "label": "aggGeoHashFnName", "description": [], + "signature": [ + "\"aggGeoHash\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", "lineNumber": 15 }, - "signature": [ - "\"aggGeoHash\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggGeoTileFnName", "type": "string", + "tags": [], "label": "aggGeoTileFnName", "description": [], + "signature": [ + "\"aggGeoTile\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggGeoTile\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggGroupName", "type": "Type", - "label": "AggGroupName", "tags": [], + "label": "AggGroupName", "description": [], + "signature": [ + "\"buckets\" | \"metrics\" | \"none\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 18 }, - "signature": [ - "\"buckets\" | \"metrics\" | \"none\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggHistogramFnName", "type": "string", + "tags": [], "label": "aggHistogramFnName", "description": [], + "signature": [ + "\"aggHistogram\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts", "lineNumber": 15 }, - "signature": [ - "\"aggHistogram\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggIpRangeFnName", "type": "string", + "tags": [], "label": "aggIpRangeFnName", "description": [], + "signature": [ + "\"aggIpRange\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts", "lineNumber": 15 }, - "signature": [ - "\"aggIpRange\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggMaxFnName", "type": "string", + "tags": [], "label": "aggMaxFnName", "description": [], + "signature": [ + "\"aggMax\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggMax\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggMedianFnName", "type": "string", + "tags": [], "label": "aggMedianFnName", "description": [], + "signature": [ + "\"aggMedian\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggMedian\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggMinFnName", "type": "string", + "tags": [], "label": "aggMinFnName", "description": [], + "signature": [ + "\"aggMin\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggMin\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggMovingAvgFnName", "type": "string", + "tags": [], "label": "aggMovingAvgFnName", "description": [], + "signature": [ + "\"aggMovingAvg\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts", "lineNumber": 14 }, - "signature": [ - "\"aggMovingAvg\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParam", "type": "Type", - "label": "AggParam", "tags": [], + "label": "AggParam", "description": [], + "signature": [ + "BaseParamType" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 28 }, - "signature": [ - "BaseParamType" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggPercentileRanksFnName", "type": "string", + "tags": [], "label": "aggPercentileRanksFnName", "description": [], + "signature": [ + "\"aggPercentileRanks\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggPercentileRanks\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggPercentilesFnName", "type": "string", + "tags": [], "label": "aggPercentilesFnName", "description": [], + "signature": [ + "\"aggPercentiles\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggPercentiles\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggRangeFnName", "type": "string", + "tags": [], "label": "aggRangeFnName", "description": [], + "signature": [ + "\"aggRange\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts", "lineNumber": 15 }, - "signature": [ - "\"aggRange\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggSerialDiffFnName", "type": "string", + "tags": [], "label": "aggSerialDiffFnName", "description": [], + "signature": [ + "\"aggSerialDiff\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts", "lineNumber": 14 }, - "signature": [ - "\"aggSerialDiff\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggSignificantTermsFnName", "type": "string", + "tags": [], "label": "aggSignificantTermsFnName", "description": [], + "signature": [ + "\"aggSignificantTerms\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggSignificantTerms\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggSinglePercentileFnName", "type": "string", + "tags": [], "label": "aggSinglePercentileFnName", "description": [], + "signature": [ + "\"aggSinglePercentile\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggSinglePercentile\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggsStart", "type": "Type", + "tags": [], "label": "AggsStart", - "tags": [ - "public" - ], "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" ], - "source": { - "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 129 - }, "signature": [ "{ calculateAutoTimeExpression: (range: ", { @@ -18836,155 +21115,243 @@ }, "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }" ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 129 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggStdDeviationFnName", "type": "string", + "tags": [], "label": "aggStdDeviationFnName", "description": [], + "signature": [ + "\"aggStdDeviation\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggStdDeviation\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggSumFnName", "type": "string", + "tags": [], "label": "aggSumFnName", "description": [], + "signature": [ + "\"aggSum\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggSum\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggTermsFnName", "type": "string", + "tags": [], "label": "aggTermsFnName", "description": [], + "signature": [ + "\"aggTerms\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts", "lineNumber": 14 }, - "signature": [ - "\"aggTerms\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.aggTopHitFnName", "type": "string", + "tags": [], "label": "aggTopHitFnName", "description": [], + "signature": [ + "\"aggTopHit\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts", "lineNumber": 13 }, - "signature": [ - "\"aggTopHit\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggTypesRegistrySetup", "type": "Type", - "label": "AggTypesRegistrySetup", "tags": [], + "label": "AggTypesRegistrySetup", "description": [], + "signature": [ + "{ registerBucket: (name: N, type: T) => void; registerMetric: (name: N, type: T) => void; }" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "lineNumber": 13 }, - "signature": [ - "{ registerBucket: (name: N, type: T) => void; registerMetric: (name: N, type: T) => void; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.autoInterval", "type": "string", + "tags": [], "label": "autoInterval", "description": [], + "signature": [ + "\"auto\"" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", "lineNumber": 12 }, - "signature": [ - "\"auto\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.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; })[]" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 12 }, - "signature": [ - "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.CreateAggConfigParams", "type": "Type", - "label": "CreateAggConfigParams", "tags": [], + "label": "CreateAggConfigParams", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 48 - }, "signature": [ "{ type: string | IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", "SerializableState", " | undefined; }" ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 49 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", + "id": "def-common.ENHANCED_ES_SEARCH_STRATEGY", + "type": "string", "tags": [], - "id": "def-common.ES_SEARCH_STRATEGY", + "label": "ENHANCED_ES_SEARCH_STRATEGY", + "description": [], + "signature": [ + "\"ese\"" + ], + "source": { + "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", + "lineNumber": 11 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.EQL_SEARCH_STRATEGY", "type": "string", - "label": "ES_SEARCH_STRATEGY", + "tags": [], + "label": "EQL_SEARCH_STRATEGY", "description": [], + "signature": [ + "\"eql\"" + ], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", - "lineNumber": 12 + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 14 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.EqlRequestParams", + "type": "Type", + "tags": [], + "label": "EqlRequestParams", + "description": [], "signature": [ - "\"es\"" + "EqlSearch>" ], + "source": { + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 16 + }, + "deprecated": false, "initialIsOpen": false }, { - "id": "def-common.EsaggsExpressionFunctionDefinition", + "parentPluginId": "data", + "id": "def-common.EqlSearchStrategyResponse", "type": "Type", - "label": "EsaggsExpressionFunctionDefinition", "tags": [], + "label": "EqlSearchStrategyResponse", + "description": [], + "signature": [ + "IKibanaSearchResponse>" + ], + "source": { + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 22 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.ES_SEARCH_STRATEGY", + "type": "string", + "tags": [], + "label": "ES_SEARCH_STRATEGY", "description": [], + "signature": [ + "\"es\"" + ], "source": { - "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", - "lineNumber": 35 + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "lineNumber": 12 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.EsaggsExpressionFunctionDefinition", + "type": "Type", + "tags": [], + "label": "EsaggsExpressionFunctionDefinition", + "description": [], "signature": [ "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", { @@ -19006,18 +21373,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", + "lineNumber": 35 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.EsdslExpressionFunctionDefinition", "type": "Type", - "label": "EsdslExpressionFunctionDefinition", "tags": [], + "label": "EsdslExpressionFunctionDefinition", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/esdsl.ts", - "lineNumber": 29 - }, "signature": [ "ExpressionFunctionDefinition<\"esdsl\", ", { @@ -19054,18 +21423,20 @@ ", ", "SerializableState" ], + "source": { + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 29 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.EsQuerySearchAfter", "type": "Type", - "label": "EsQuerySearchAfter", "tags": [], + "label": "EsQuerySearchAfter", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 37 - }, "signature": [ "[", "ReactText", @@ -19073,63 +21444,71 @@ "ReactText", "]" ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 38 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.EsQuerySortValue", "type": "Type", - "label": "EsQuerySortValue", "tags": [], + "label": "EsQuerySortValue", "description": [], + "signature": [ + "{ [x: string]: SortDirection | SortDirectionNumeric | SortDirectionFormat; }" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 49 + "lineNumber": 55 }, - "signature": [ - "{ [x: string]: SortDirection | SortDirectionNumeric; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.EsRawResponseExpressionTypeDefinition", "type": "Type", - "label": "EsRawResponseExpressionTypeDefinition", "tags": [], + "label": "EsRawResponseExpressionTypeDefinition", "description": [], + "signature": [ + "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" + ], "source": { "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "lineNumber": 57 }, - "signature": [ - "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExecutionContextSearch", "type": "Type", - "label": "ExecutionContextSearch", "tags": [], + "label": "ExecutionContextSearch", "description": [], + "signature": [ + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 15 }, - "signature": [ - "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionExistsFilter", "type": "Type", - "label": "ExpressionFunctionExistsFilter", - "tags": [], - "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/exists_filter.ts", - "lineNumber": 20 - }, + "tags": [], + "label": "ExpressionFunctionExistsFilter", + "description": [], "signature": [ "ExpressionFunctionDefinition<\"existsFilter\", null, Arguments, ", { @@ -19166,18 +21545,20 @@ ", ", "SerializableState" ], + "source": { + "path": "src/plugins/data/common/search/expressions/exists_filter.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionField", "type": "Type", - "label": "ExpressionFunctionField", "tags": [], + "label": "ExpressionFunctionField", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/field.ts", - "lineNumber": 19 - }, "signature": [ "ExpressionFunctionDefinition<\"field\", null, Arguments, ", { @@ -19214,18 +21595,20 @@ ", ", "SerializableState" ], + "source": { + "path": "src/plugins/data/common/search/expressions/field.ts", + "lineNumber": 19 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionKibana", "type": "Type", - "label": "ExpressionFunctionKibana", "tags": [], + "label": "ExpressionFunctionKibana", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kibana.ts", - "lineNumber": 17 - }, "signature": [ "ExpressionFunctionDefinition<\"kibana\", ", { @@ -19245,18 +21628,20 @@ }, "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" ], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 17 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionKibanaContext", "type": "Type", - "label": "ExpressionFunctionKibanaContext", "tags": [], + "label": "ExpressionFunctionKibanaContext", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_context.ts", - "lineNumber": 34 - }, "signature": [ "ExpressionFunctionDefinition<\"kibana_context\", ", { @@ -19276,18 +21661,20 @@ }, "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" ], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 34 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionKibanaFilter", "type": "Type", - "label": "ExpressionFunctionKibanaFilter", "tags": [], + "label": "ExpressionFunctionKibanaFilter", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", - "lineNumber": 18 - }, "signature": [ "ExpressionFunctionDefinition<\"kibanaFilter\", null, Arguments, ", { @@ -19324,18 +21711,20 @@ ", ", "SerializableState" ], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", + "lineNumber": 18 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionKibanaTimerange", "type": "Type", - "label": "ExpressionFunctionKibanaTimerange", "tags": [], + "label": "ExpressionFunctionKibanaTimerange", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/timerange.ts", - "lineNumber": 15 - }, "signature": [ "ExpressionFunctionDefinition<\"timerange\", null, TimeRange, ExpressionValueBoxed<\"timerange\", TimeRange>, ", { @@ -19357,18 +21746,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/data/common/search/expressions/timerange.ts", + "lineNumber": 15 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionKql", "type": "Type", - "label": "ExpressionFunctionKql", "tags": [], + "label": "ExpressionFunctionKql", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kql.ts", - "lineNumber": 17 - }, "signature": [ "ExpressionFunctionDefinition<\"kql\", null, Arguments, ", { @@ -19405,18 +21796,20 @@ ", ", "SerializableState" ], + "source": { + "path": "src/plugins/data/common/search/expressions/kql.ts", + "lineNumber": 17 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionLucene", "type": "Type", - "label": "ExpressionFunctionLucene", "tags": [], + "label": "ExpressionFunctionLucene", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/lucene.ts", - "lineNumber": 17 - }, "signature": [ "ExpressionFunctionDefinition<\"lucene\", null, Arguments, ", { @@ -19453,18 +21846,20 @@ ", ", "SerializableState" ], + "source": { + "path": "src/plugins/data/common/search/expressions/lucene.ts", + "lineNumber": 17 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionPhraseFilter", "type": "Type", - "label": "ExpressionFunctionPhraseFilter", "tags": [], + "label": "ExpressionFunctionPhraseFilter", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", - "lineNumber": 21 - }, "signature": [ "ExpressionFunctionDefinition<\"rangeFilter\", null, Arguments, ", { @@ -19501,18 +21896,20 @@ ", ", "SerializableState" ], + "source": { + "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionRange", "type": "Type", - "label": "ExpressionFunctionRange", "tags": [], + "label": "ExpressionFunctionRange", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/range.ts", - "lineNumber": 21 - }, "signature": [ "ExpressionFunctionDefinition<\"range\", null, Arguments, ExpressionValueBoxed<\"kibana_range\", Arguments>, ", { @@ -19534,18 +21931,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/data/common/search/expressions/range.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionFunctionRangeFilter", "type": "Type", - "label": "ExpressionFunctionRangeFilter", "tags": [], + "label": "ExpressionFunctionRangeFilter", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/range_filter.ts", - "lineNumber": 22 - }, "signature": [ "ExpressionFunctionDefinition<\"rangeFilter\", null, Arguments, ", { @@ -19582,33 +21981,37 @@ ", ", "SerializableState" ], + "source": { + "path": "src/plugins/data/common/search/expressions/range_filter.ts", + "lineNumber": 22 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ExpressionValueSearchContext", "type": "Type", - "label": "ExpressionValueSearchContext", "tags": [], + "label": "ExpressionValueSearchContext", "description": [], + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 21 }, - "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.FieldTypes", "type": "Type", - "label": "FieldTypes", "tags": [], + "label": "FieldTypes", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 22 - }, "signature": [ { "pluginId": "data", @@ -19650,96 +22053,108 @@ "text": "KBN_FIELD_TYPES" } ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 22 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IAggConfig", "type": "Type", - "label": "IAggConfig", "tags": [ "name", "description" ], + "label": "IAggConfig", "description": [], + "signature": [ + "AggConfig" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 53 }, - "signature": [ - "AggConfig" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IAggType", "type": "Type", - "label": "IAggType", "tags": [], + "label": "IAggType", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 59 - }, "signature": [ "AggType>" ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 62 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IEsSearchResponse", "type": "Type", - "label": "IEsSearchResponse", "tags": [], + "label": "IEsSearchResponse", "description": [], - "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", - "lineNumber": 22 - }, "signature": [ "IKibanaSearchResponse>" ], + "source": { + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "lineNumber": 22 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IFieldParamType", "type": "Type", - "label": "IFieldParamType", "tags": [], + "label": "IFieldParamType", "description": [], + "signature": [ + "FieldParamType" + ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 24 }, - "signature": [ - "FieldParamType" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IMetricAggType", "type": "Type", - "label": "IMetricAggType", "tags": [], + "label": "IMetricAggType", "description": [], + "signature": [ + "MetricAggType" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 35 }, - "signature": [ - "MetricAggType" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.intervalOptions", "type": "Array", + "tags": [], "label": "intervalOptions", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", - "lineNumber": 15 - }, "signature": [ "({ display: string; val: string; enabled(agg: ", { @@ -19751,48 +22166,54 @@ }, "): boolean; } | { display: string; val: string; })[]" ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", + "lineNumber": 15 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IPercentileAggConfig", "type": "Type", - "label": "IPercentileAggConfig", "tags": [], + "label": "IPercentileAggConfig", "description": [], + "signature": [ + "IResponseAggConfig" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "lineNumber": 24 }, - "signature": [ - "IResponseAggConfig" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IPercentileRanksAggConfig", "type": "Type", - "label": "IPercentileRanksAggConfig", "tags": [], + "label": "IPercentileRanksAggConfig", "description": [], + "signature": [ + "IResponseAggConfig" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 27 }, - "signature": [ - "IResponseAggConfig" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IpRangeKey", "type": "Type", - "label": "IpRangeKey", "tags": [], + "label": "IpRangeKey", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", - "lineNumber": 20 - }, "signature": [ { "pluginId": "data", @@ -19810,18 +22231,20 @@ "text": "RangeIpRangeAggKey" } ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ISearchCancelGeneric", "type": "Type", - "label": "ISearchCancelGeneric", "tags": [], + "label": "ISearchCancelGeneric", "description": [], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 21 - }, "signature": [ "(id: string, options: ", { @@ -19833,18 +22256,20 @@ }, " | undefined) => Promise" ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ISearchExtendGeneric", "type": "Type", - "label": "ISearchExtendGeneric", "tags": [], + "label": "ISearchExtendGeneric", "description": [], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 22 - }, "signature": [ "(id: string, keepAlive: string, options: ", { @@ -19856,18 +22281,20 @@ }, " | undefined) => Promise" ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 22 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ISearchGeneric", "type": "Type", - "label": "ISearchGeneric", "tags": [], + "label": "ISearchGeneric", "description": [], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 13 - }, "signature": [ "(request: SearchStrategyRequest, options: ", { @@ -19881,381 +22308,474 @@ "Observable", "" ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ISearchOptionsSerializable", "type": "Type", - "label": "ISearchOptionsSerializable", "tags": [], + "label": "ISearchOptionsSerializable", "description": [ "\nSame as `ISearchOptions`, but contains only serializable fields, which can\nbe sent over the network." ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 127 - }, "signature": [ "{ isStored?: boolean | undefined; isRestore?: boolean | undefined; sessionId?: string | undefined; strategy?: string | undefined; legacyHitsTotal?: boolean | undefined; }" ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 138 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ISearchRequestParams", "type": "Type", - "label": "ISearchRequestParams", "tags": [], + "label": "ISearchRequestParams", "description": [], - "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", - "lineNumber": 14 - }, "signature": [ "{ trackTotalHits?: boolean | undefined; } & estypes.SearchRequest" ], + "source": { + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ISearchSource", "type": "Type", + "tags": [], "label": "ISearchSource", - "tags": [ - "public" - ], "description": [ "\nsearch source interface" ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 19 - }, "signature": [ "{ create: () => SearchSource; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: SearchSourceFields[K]) => SearchSource; removeField: (field: K) => SearchSource; setFields: (newFields: SearchSourceFields) => SearchSource; getId: () => string; getFields: () => SearchSourceFields; getField: (field: K, recurse?: boolean) => SearchSourceFields[K]; getOwnField: (field: K) => SearchSourceFields[K]; createCopy: () => SearchSource; createChild: (options?: {}) => SearchSource; setParent: (parent?: Pick | undefined, options?: SearchSourceOptions) => SearchSource; getParent: () => SearchSource | undefined; fetch$: (options?: ", { "pluginId": "data", - "scope": "common", + "scope": "public", "docId": "kibDataPluginApi", - "section": "def-common.ISearchOptions", + "section": "def-public.ISearchOptions", "text": "ISearchOptions" }, ") => ", "Observable", "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", "SearchResponse", - ">; fetch: (options?: ", + ">>; fetch: (options?: ", { "pluginId": "data", - "scope": "common", + "scope": "public", "docId": "kibDataPluginApi", - "section": "def-common.ISearchOptions", + "section": "def-public.ISearchOptions", "text": "ISearchOptions" - }, - ") => Promise<", - "SearchResponse" + } ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KIBANA_CONTEXT_NAME", "type": "Type", - "label": "KIBANA_CONTEXT_NAME", "tags": [], + "label": "KIBANA_CONTEXT_NAME", "description": [], + "signature": [ + "\"kibana_context\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 31 }, - "signature": [ - "\"kibana_context\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KibanaContext", "type": "Type", - "label": "KibanaContext", "tags": [], + "label": "KibanaContext", "description": [], + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 32 }, - "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KibanaField", "type": "Type", - "label": "KibanaField", "tags": [], + "label": "KibanaField", "description": [], + "signature": [ + "{ type: \"kibana_field\"; } & IndexPatternField" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 28 }, - "signature": [ - "{ type: \"kibana_field\"; } & IndexPatternField" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KibanaFilter", "type": "Type", - "label": "KibanaFilter", "tags": [], + "label": "KibanaFilter", "description": [], + "signature": [ + "{ type: \"kibana_filter\"; } & Filter" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 27 }, - "signature": [ - "{ type: \"kibana_filter\"; } & Filter" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KibanaQueryOutput", "type": "Type", - "label": "KibanaQueryOutput", "tags": [], + "label": "KibanaQueryOutput", "description": [], + "signature": [ + "{ type: \"kibana_query\"; } & Query" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 26 }, - "signature": [ - "{ type: \"kibana_query\"; } & Query" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KibanaRange", "type": "Type", - "label": "KibanaRange", "tags": [], + "label": "KibanaRange", "description": [], + "signature": [ + "{ type: \"kibana_range\"; } & Arguments" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 19 }, - "signature": [ - "{ type: \"kibana_range\"; } & Arguments" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.KibanaTimerangeOutput", "type": "Type", - "label": "KibanaTimerangeOutput", "tags": [], + "label": "KibanaTimerangeOutput", "description": [], + "signature": [ + "{ type: \"timerange\"; } & TimeRange" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 13 }, - "signature": [ - "{ type: \"timerange\"; } & TimeRange" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.parentPipelineType", "type": "string", + "tags": [], "label": "parentPipelineType", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 28 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.ParsedInterval", "type": "Type", - "label": "ParsedInterval", "tags": [], + "label": "ParsedInterval", "description": [], + "signature": [ + "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", "lineNumber": 18 }, - "signature": [ - "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SEARCH_SESSION_TYPE", "type": "string", + "tags": [], "label": "SEARCH_SESSION_TYPE", "description": [], + "signature": [ + "\"search-session\"" + ], "source": { "path": "src/plugins/data/common/search/session/types.ts", "lineNumber": 11 }, - "signature": [ - "\"search-session\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SEARCH_SESSIONS_TABLE_ID", "type": "string", + "tags": [], "label": "SEARCH_SESSIONS_TABLE_ID", "description": [], + "signature": [ + "\"searchSessionsMgmtUiTable\"" + ], "source": { "path": "src/plugins/data/common/search/session/index.ts", "lineNumber": 12 }, - "signature": [ - "\"searchSessionsMgmtUiTable\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchFieldValue", "type": "Type", - "label": "SearchFieldValue", "tags": [], + "label": "SearchFieldValue", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 56 - }, "signature": [ "string | SearchField" ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 65 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.siblingPipelineType", "type": "string", + "tags": [], "label": "siblingPipelineType", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 35 }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.termsAggFilter", "type": "Array", + "tags": [], "label": "termsAggFilter", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 32 - }, "signature": [ "string[]" ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 30 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "data", "id": "def-common.AggGroupLabels", "type": "Object", "tags": [], + "label": "AggGroupLabels", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.Buckets", "type": "string", + "tags": [], "label": "[AggGroupNames.Buckets]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.Metrics", "type": "string", + "tags": [], "label": "[AggGroupNames.Metrics]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.None", "type": "string", + "tags": [], "label": "[AggGroupNames.None]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 27 - } + }, + "deprecated": false } ], - "description": [], - "label": "AggGroupLabels", - "source": { - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggGroupNames", "type": "Object", + "tags": [], "label": "AggGroupNames", "description": [], + "signature": [ + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 12 }, - "signature": [ - "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.esRawResponse", "type": "Object", "tags": [], + "label": "esRawResponse", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.esRawResponse.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"es_raw_response\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "lineNumber": 64 }, - "signature": [ - "\"es_raw_response\"" - ] + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.esRawResponse.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.esRawResponse.to.datatable", "type": "Function", + "tags": [], + "label": "datatable", + "description": [], + "signature": [ + "(context: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsRawResponse", + "text": "EsRawResponse" + }, + ") => { type: string; meta: { type: string; source: string; }; columns: { id: string; name: string; meta: { type: \"string\" | \"number\" | \"bigint\" | \"boolean\" | \"symbol\" | \"undefined\" | \"object\" | \"function\"; field: string; params: {}; }; }[]; rows: any[]; }" + ], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 66 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.esRawResponse.to.datatable.$1", "type": "Object", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -20266,229 +22786,237 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "lineNumber": 66 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(context: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.EsRawResponse", - "text": "EsRawResponse" - }, - ") => { type: string; meta: { type: string; source: string; }; columns: { id: string; name: string; meta: { type: \"string\" | \"number\" | \"bigint\" | \"boolean\" | \"symbol\" | \"undefined\" | \"object\" | \"function\"; field: string; params: {}; }; }[]; rows: any[]; }" - ], - "description": [], - "label": "datatable", - "source": { - "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", - "lineNumber": 66 - }, - "tags": [], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", - "lineNumber": 65 - } + ] } ], - "description": [], - "label": "esRawResponse", - "source": { - "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", - "lineNumber": 63 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.existsFilterFunction", "type": "Object", "tags": [], + "label": "existsFilterFunction", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/exists_filter.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.existsFilterFunction.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"existsFilter\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 28 }, - "signature": [ - "\"existsFilter\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.existsFilterFunction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_filter\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 29 }, - "signature": [ - "\"kibana_filter\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.existsFilterFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 30 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.existsFilterFunction.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.existsFilterFunction.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/exists_filter.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.field", "type": "Object", "tags": [], + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/exists_filter.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.field.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"kibana_field\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 36 }, - "signature": [ - "\"kibana_field\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.field.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 37 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.field.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 38 - } + }, + "deprecated": false } - ], - "description": [], - "label": "field", - "source": { - "path": "src/plugins/data/common/search/expressions/exists_filter.ts", - "lineNumber": 35 - } + ] }, { + "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.negate", "type": "Object", "tags": [], + "label": "negate", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/exists_filter.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.negate.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"boolean\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 43 }, - "signature": [ - "\"boolean\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.negate.default", "type": "boolean", + "tags": [], "label": "default", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 44 }, - "signature": [ - "false" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.negate.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 45 - } + }, + "deprecated": false } - ], - "description": [], - "label": "negate", - "source": { - "path": "src/plugins/data/common/search/expressions/exists_filter.ts", - "lineNumber": 42 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/data/common/search/expressions/exists_filter.ts", - "lineNumber": 34 - } + ] }, { + "parentPluginId": "data", "id": "def-common.existsFilterFunction.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: null, args: Arguments) => { $state?: ", { @@ -20508,270 +23036,312 @@ }, "; query?: any; type: \"kibana_filter\"; }" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/exists_filter.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.existsFilterFunction.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 51 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.existsFilterFunction.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 51 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/exists_filter.ts", - "lineNumber": 51 - } + "returnComment": [] } ], - "description": [], - "label": "existsFilterFunction", - "source": { - "path": "src/plugins/data/common/search/expressions/exists_filter.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.fieldFunction", "type": "Object", "tags": [], + "label": "fieldFunction", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/field.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"field\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 27 }, - "signature": [ - "\"field\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_field\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 28 }, - "signature": [ - "\"kibana_field\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 29 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.fieldFunction.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/field.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.fieldFunction.args.name", "type": "Object", "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/field.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.args.name.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 35 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.args.name.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 36 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.args.name.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 37 - } + }, + "deprecated": false } - ], - "description": [], - "label": "name", - "source": { - "path": "src/plugins/data/common/search/expressions/field.ts", - "lineNumber": 34 - } + ] }, { + "parentPluginId": "data", "id": "def-common.fieldFunction.args.type", "type": "Object", "tags": [], + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/field.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.args.type.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 42 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.args.type.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 43 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.args.type.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 44 - } + }, + "deprecated": false } - ], - "description": [], - "label": "type", - "source": { - "path": "src/plugins/data/common/search/expressions/field.ts", - "lineNumber": 41 - } + ] }, { + "parentPluginId": "data", "id": "def-common.fieldFunction.args.script", "type": "Object", "tags": [], + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/field.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.args.script.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 49 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.fieldFunction.args.script.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 50 - } + }, + "deprecated": false } - ], - "description": [], - "label": "script", - "source": { - "path": "src/plugins/data/common/search/expressions/field.ts", - "lineNumber": 48 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/data/common/search/expressions/field.ts", - "lineNumber": 33 - } + ] }, { + "parentPluginId": "data", "id": "def-common.fieldFunction.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: null, args: Arguments) => ", { @@ -20791,127 +23361,147 @@ }, ">" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/field.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.fieldFunction.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 56 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.fieldFunction.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 56 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/field.ts", - "lineNumber": 56 - } + "returnComment": [] } ], - "description": [], - "label": "fieldFunction", - "source": { - "path": "src/plugins/data/common/search/expressions/field.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.kibana", "type": "Object", "tags": [], + "label": "kibana", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibana.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"kibana\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 27 }, - "signature": [ - "\"kibana\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibana.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_context\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 28 }, - "signature": [ - "\"kibana_context\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibana.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "(\"kibana_context\" | \"null\")[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 30 }, - "signature": [ - "(\"kibana_context\" | \"null\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibana.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.kibana.args", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "args", + "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "children": [] }, { + "parentPluginId": "data", "id": "def-common.kibana.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: Input, _: object, { getSearchContext }: ", { @@ -20954,41 +23544,53 @@ "text": "ExecutionContextSearch" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.kibana.fn.$1", "type": "CompoundType", + "tags": [], "label": "input", - "isRequired": false, + "description": [], "signature": [ "Input" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "data", "id": "def-common.kibana.fn.$2", "type": "Uncategorized", + "tags": [], "label": "_", - "isRequired": true, + "description": [], "signature": [ "object" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.kibana.fn.$3", "type": "Object", + "tags": [], "label": "{ getSearchContext }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -21015,586 +23617,671 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kibana.ts", - "lineNumber": 38 - } + "returnComment": [] } ], - "description": [], - "label": "kibana", - "source": { - "path": "src/plugins/data/common/search/expressions/kibana.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.kibanaContext", "type": "Object", "tags": [], + "label": "kibanaContext", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaContext.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 35 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.kibanaContext.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.kibanaContext.from.null", "type": "Function", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => { type: string; }" ], - "description": [], - "label": "null", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 37 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "lineNumber": 36 - } + ] }, { + "parentPluginId": "data", "id": "def-common.kibanaContext.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.kibanaContext.to.null", "type": "Function", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => { type: string; }" ], - "description": [], - "label": "null", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 44 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "lineNumber": 43 - } + ] } ], - "description": [], - "label": "kibanaContext", - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction", "type": "Object", "tags": [], + "label": "kibanaFilterFunction", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"kibanaFilter\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 26 }, - "signature": [ - "\"kibanaFilter\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_filter\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 27 }, - "signature": [ - "\"kibana_filter\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 28 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 29 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query", "type": "Object", "tags": [], + "label": "query", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 34 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 35 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 36 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 37 - } + }, + "deprecated": false } - ], - "description": [], - "label": "query", - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", - "lineNumber": 33 - } + ] }, { + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.negate", "type": "Object", "tags": [], + "label": "negate", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.negate.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"boolean\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 42 }, - "signature": [ - "\"boolean\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.negate.default", "type": "boolean", + "tags": [], "label": "default", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 43 }, - "signature": [ - "false" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.negate.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 44 - } + }, + "deprecated": false } - ], - "description": [], - "label": "negate", - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", - "lineNumber": 41 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", - "lineNumber": 32 - } + ] }, { + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: null, args: Arguments) => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 50 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 50 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", - "lineNumber": 50 - } + "returnComment": [] } ], - "description": [], - "label": "kibanaFilterFunction", - "source": { - "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction", "type": "Object", "tags": [], + "label": "kibanaTimerangeFunction", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/timerange.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"timerange\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 23 }, - "signature": [ - "\"timerange\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"timerange\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 24 }, - "signature": [ - "\"timerange\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 25 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 26 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/timerange.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/timerange.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.from.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 31 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.from.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 32 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.from.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 33 - } + }, + "deprecated": false } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/data/common/search/expressions/timerange.ts", - "lineNumber": 30 - } + ] }, { + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/timerange.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.to.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 38 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.to.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 39 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.to.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 40 - } + }, + "deprecated": false } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/data/common/search/expressions/timerange.ts", - "lineNumber": 37 - } + ] }, { + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.mode", "type": "Object", "tags": [], + "label": "mode", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/timerange.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.mode.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 45 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.mode.options", "type": "Array", + "tags": [], "label": "options", "description": [], + "signature": [ + "(\"absolute\" | \"relative\")[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 46 }, - "signature": [ - "(\"absolute\" | \"relative\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.mode.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 47 - } + }, + "deprecated": false } - ], - "description": [], - "label": "mode", - "source": { - "path": "src/plugins/data/common/search/expressions/timerange.ts", - "lineNumber": 44 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/data/common/search/expressions/timerange.ts", - "lineNumber": 29 - } + ] }, { + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: null, args: ", { @@ -21606,27 +24293,36 @@ }, ") => { type: \"timerange\"; from: string; to: string; mode: \"absolute\" | \"relative\" | undefined; }" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/timerange.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -21636,421 +24332,468 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/timerange.ts", - "lineNumber": 53 - } + "returnComment": [] } ], - "description": [], - "label": "kibanaTimerangeFunction", - "source": { - "path": "src/plugins/data/common/search/expressions/timerange.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.kqlFunction", "type": "Object", "tags": [], + "label": "kqlFunction", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kql.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kqlFunction.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"kql\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 25 }, - "signature": [ - "\"kql\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kqlFunction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_query\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 26 }, - "signature": [ - "\"kibana_query\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kqlFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 27 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kqlFunction.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.kqlFunction.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kql.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.kqlFunction.args.q", "type": "Object", "tags": [], + "label": "q", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kql.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.kqlFunction.args.q.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 33 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kqlFunction.args.q.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 34 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kqlFunction.args.q.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 35 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.kqlFunction.args.q.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 36 - } + }, + "deprecated": false } - ], - "description": [], - "label": "q", - "source": { - "path": "src/plugins/data/common/search/expressions/kql.ts", - "lineNumber": 32 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/data/common/search/expressions/kql.ts", - "lineNumber": 31 - } + ] }, { + "parentPluginId": "data", "id": "def-common.kqlFunction.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: null, args: Arguments) => { type: \"kibana_query\"; language: string; query: string; }" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kql.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.kqlFunction.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.kqlFunction.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/kql.ts", - "lineNumber": 42 - } + "returnComment": [] } ], - "description": [], - "label": "kqlFunction", - "source": { - "path": "src/plugins/data/common/search/expressions/kql.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.luceneFunction", "type": "Object", "tags": [], + "label": "luceneFunction", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/lucene.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.luceneFunction.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"lucene\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 25 }, - "signature": [ - "\"lucene\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.luceneFunction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_query\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 26 }, - "signature": [ - "\"kibana_query\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.luceneFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 27 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.luceneFunction.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.luceneFunction.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/lucene.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.luceneFunction.args.q", "type": "Object", "tags": [], + "label": "q", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/lucene.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.luceneFunction.args.q.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 33 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.luceneFunction.args.q.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 34 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.luceneFunction.args.q.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 35 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.luceneFunction.args.q.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 36 - } + }, + "deprecated": false } - ], - "description": [], - "label": "q", - "source": { - "path": "src/plugins/data/common/search/expressions/lucene.ts", - "lineNumber": 32 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/data/common/search/expressions/lucene.ts", - "lineNumber": 31 - } + ] }, { + "parentPluginId": "data", "id": "def-common.luceneFunction.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: null, args: Arguments) => { type: \"kibana_query\"; language: string; query: any; }" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/lucene.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.luceneFunction.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.luceneFunction.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/lucene.ts", - "lineNumber": 42 - } + "returnComment": [] } ], - "description": [], - "label": "luceneFunction", - "source": { - "path": "src/plugins/data/common/search/expressions/lucene.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.migrateIncludeExcludeFormat", "type": "Object", + "tags": [], "label": "migrateIncludeExcludeFormat", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "lineNumber": 25 - }, "signature": [ "Partial<", { @@ -22070,28 +24813,46 @@ }, ">>" ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 25 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper", "type": "Object", "tags": [], + "label": "parentPipelineAggHelper", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper.subtype", "type": "string", + "tags": [], "label": "subtype", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 36 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper.params", "type": "Function", + "tags": [], "label": "params", + "description": [], "signature": [ "() => ", { @@ -22111,19 +24872,21 @@ }, ">[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 37 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper.getSerializedFormat", "type": "Function", + "tags": [], "label": "getSerializedFormat", + "description": [], "signature": [ "(agg: ", { @@ -22135,13 +24898,19 @@ }, ") => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper.getSerializedFormat.$1", "type": "Object", + "tags": [], "label": "agg", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -22151,274 +24920,311 @@ "text": "IMetricAggConfig" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 65 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", - "lineNumber": 65 - } + "returnComment": [] } ], - "description": [], - "label": "parentPipelineAggHelper", - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.phraseFilterFunction", "type": "Object", "tags": [], + "label": "phraseFilterFunction", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"rangeFilter\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 29 }, - "signature": [ - "\"rangeFilter\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_filter\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 30 }, - "signature": [ - "\"kibana_filter\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 31 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.field", "type": "Object", "tags": [], + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.field.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"kibana_field\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 37 }, - "signature": [ - "\"kibana_field\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.field.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 38 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.field.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 39 - } + }, + "deprecated": false } - ], - "description": [], - "label": "field", - "source": { - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", - "lineNumber": 36 - } + ] }, { + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase", "type": "Object", "tags": [], + "label": "phrase", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 44 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase.multi", "type": "boolean", + "tags": [], "label": "multi", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 45 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 46 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 47 - } + }, + "deprecated": false } - ], - "description": [], - "label": "phrase", - "source": { - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", - "lineNumber": 43 - } + ] }, { + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.negate", "type": "Object", "tags": [], + "label": "negate", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.negate.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"boolean\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 52 }, - "signature": [ - "\"boolean\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.negate.default", "type": "boolean", + "tags": [], "label": "default", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 53 }, - "signature": [ - "false" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.negate.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 54 - } + }, + "deprecated": false } - ], - "description": [], - "label": "negate", - "source": { - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", - "lineNumber": 51 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", - "lineNumber": 35 - } + ] }, { + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: null, args: Arguments) => { $state?: ", { @@ -22438,284 +25244,328 @@ }, "; query?: any; type: \"kibana_filter\"; }" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.phraseFilterFunction.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", - "lineNumber": 60 - } + "returnComment": [] } ], - "description": [], - "label": "phraseFilterFunction", - "source": { - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.rangeFilterFunction", "type": "Object", "tags": [], + "label": "rangeFilterFunction", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range_filter.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"rangeFilter\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 30 }, - "signature": [ - "\"rangeFilter\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_filter\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 31 }, - "signature": [ - "\"kibana_filter\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 32 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range_filter.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.field", "type": "Object", "tags": [], + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range_filter.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.field.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"kibana_field\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 38 }, - "signature": [ - "\"kibana_field\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.field.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 39 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.field.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 40 - } + }, + "deprecated": false } - ], - "description": [], - "label": "field", - "source": { - "path": "src/plugins/data/common/search/expressions/range_filter.ts", - "lineNumber": 37 - } + ] }, { + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.range", "type": "Object", "tags": [], + "label": "range", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range_filter.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.range.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"kibana_range\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 45 }, - "signature": [ - "\"kibana_range\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.range.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 46 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.range.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 47 - } + }, + "deprecated": false } - ], - "description": [], - "label": "range", - "source": { - "path": "src/plugins/data/common/search/expressions/range_filter.ts", - "lineNumber": 44 - } + ] }, { + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.negate", "type": "Object", "tags": [], + "label": "negate", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range_filter.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.negate.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"boolean\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 52 }, - "signature": [ - "\"boolean\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.negate.default", "type": "boolean", + "tags": [], "label": "default", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 53 }, - "signature": [ - "false" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.negate.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 54 - } - } - ], - "description": [], - "label": "negate", - "source": { - "path": "src/plugins/data/common/search/expressions/range_filter.ts", - "lineNumber": 51 - } + }, + "deprecated": false + } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/data/common/search/expressions/range_filter.ts", - "lineNumber": 36 - } + ] }, { + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: null, args: Arguments) => { $state?: ", { @@ -22735,350 +25585,406 @@ }, "; query?: any; type: \"kibana_filter\"; }" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range_filter.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.rangeFilterFunction.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/range_filter.ts", - "lineNumber": 60 - } + "returnComment": [] } ], - "description": [], - "label": "rangeFilterFunction", - "source": { - "path": "src/plugins/data/common/search/expressions/range_filter.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.rangeFunction", "type": "Object", "tags": [], + "label": "rangeFunction", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"range\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 29 }, - "signature": [ - "\"range\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_range\"" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 30 }, - "signature": [ - "\"kibana_range\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 31 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.rangeFunction.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.rangeFunction.args.gt", "type": "Object", "tags": [], + "label": "gt", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.args.gt.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "(\"string\" | \"number\")[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 37 }, - "signature": [ - "(\"string\" | \"number\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.args.gt.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 38 - } + }, + "deprecated": false } - ], - "description": [], - "label": "gt", - "source": { - "path": "src/plugins/data/common/search/expressions/range.ts", - "lineNumber": 36 - } + ] }, { + "parentPluginId": "data", "id": "def-common.rangeFunction.args.lt", "type": "Object", "tags": [], + "label": "lt", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.args.lt.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "(\"string\" | \"number\")[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 43 }, - "signature": [ - "(\"string\" | \"number\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.args.lt.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 44 - } + }, + "deprecated": false } - ], - "description": [], - "label": "lt", - "source": { - "path": "src/plugins/data/common/search/expressions/range.ts", - "lineNumber": 42 - } + ] }, { + "parentPluginId": "data", "id": "def-common.rangeFunction.args.gte", "type": "Object", "tags": [], + "label": "gte", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.args.gte.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "(\"string\" | \"number\")[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 49 }, - "signature": [ - "(\"string\" | \"number\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.args.gte.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 50 - } + }, + "deprecated": false } - ], - "description": [], - "label": "gte", - "source": { - "path": "src/plugins/data/common/search/expressions/range.ts", - "lineNumber": 48 - } + ] }, { + "parentPluginId": "data", "id": "def-common.rangeFunction.args.lte", "type": "Object", "tags": [], + "label": "lte", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.args.lte.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "(\"string\" | \"number\")[]" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 55 }, - "signature": [ - "(\"string\" | \"number\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.rangeFunction.args.lte.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 56 - } + }, + "deprecated": false } - ], - "description": [], - "label": "lte", - "source": { - "path": "src/plugins/data/common/search/expressions/range.ts", - "lineNumber": 54 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/data/common/search/expressions/range.ts", - "lineNumber": 35 - } + ] }, { + "parentPluginId": "data", "id": "def-common.rangeFunction.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: null, args: Arguments) => { gt?: string | number | undefined; lt?: string | number | undefined; gte?: string | number | undefined; lte?: string | number | undefined; type: \"kibana_range\"; }" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/range.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.rangeFunction.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 62 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.rangeFunction.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 62 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/expressions/range.ts", - "lineNumber": 62 - } + "returnComment": [] } ], - "description": [], - "label": "rangeFunction", - "source": { - "path": "src/plugins/data/common/search/expressions/range.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper", "type": "Object", "tags": [], + "label": "siblingPipelineAggHelper", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.subtype", "type": "string", + "tags": [], "label": "subtype", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 43 - } + }, + "deprecated": false }, { + "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.params", "type": "Function", + "tags": [], "label": "params", + "description": [], "signature": [ "(bucketFilter?: string[]) => ", { @@ -23098,34 +26004,39 @@ }, ">[]" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.params.$1", "type": "Array", + "tags": [], "label": "bucketFilter", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 44 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", - "lineNumber": 44 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.getSerializedFormat", "type": "Function", + "tags": [], "label": "getSerializedFormat", + "description": [], "signature": [ "(agg: ", { @@ -23137,13 +26048,19 @@ }, ") => any" ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.getSerializedFormat.$1", "type": "Object", + "tags": [], "label": "agg", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -23153,27 +26070,17 @@ "text": "IMetricAggConfig" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 80 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", - "lineNumber": 80 - } + "returnComment": [] } ], - "description": [], - "label": "siblingPipelineAggHelper", - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", - "lineNumber": 42 - }, "initialIsOpen": false } ] diff --git a/api_docs/data_ui.json b/api_docs/data_ui.json index e121f55bd6bbf..63b9a1e1a1001 100644 --- a/api_docs/data_ui.json +++ b/api_docs/data_ui.json @@ -4,14 +4,36 @@ "classes": [], "functions": [ { + "parentPluginId": "data", "id": "def-public.QueryStringInput", "type": "Function", + "tags": [], + "label": "QueryStringInput", + "description": [], + "signature": [ + "(props: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataUiPluginApi", + "section": "def-public.QueryStringInputProps", + "text": "QueryStringInputProps" + }, + ") => JSX.Element" + ], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/index.tsx", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.QueryStringInput.$1", "type": "Object", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -21,53 +43,39 @@ "text": "QueryStringInputProps" } ], - "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/index.tsx", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(props: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataUiPluginApi", - "section": "def-public.QueryStringInputProps", - "text": "QueryStringInputProps" - }, - ") => JSX.Element" - ], - "description": [], - "label": "QueryStringInput", - "source": { - "path": "src/plugins/data/public/ui/query_string_input/index.tsx", - "lineNumber": 24 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "data", "id": "def-public.QueryStringInputProps", "type": "Interface", + "tags": [], "label": "QueryStringInputProps", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.indexPatterns", "type": "Array", + "tags": [], "label": "indexPatterns", "description": [], - "source": { - "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 43 - }, "signature": [ "(string | ", { @@ -78,18 +86,20 @@ "text": "IIndexPattern" }, ")[]" - ] + ], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 43 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.query", "type": "Object", + "tags": [], "label": "query", "description": [], - "source": { - "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 44 - }, "signature": [ { "pluginId": "data", @@ -98,145 +108,165 @@ "section": "def-common.Query", "text": "Query" } - ] + ], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 44 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.disableAutoFocus", "type": "CompoundType", + "tags": [], "label": "disableAutoFocus", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 45 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.screenTitle", "type": "string", + "tags": [], "label": "screenTitle", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 46 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.prepend", "type": "Any", + "tags": [], "label": "prepend", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 47 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.persistedLog", "type": "Object", + "tags": [], "label": "persistedLog", "description": [], + "signature": [ + "PersistedLog", + " | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 48 }, - "signature": [ - "PersistedLog", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.bubbleSubmitEvent", "type": "CompoundType", + "tags": [], "label": "bubbleSubmitEvent", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 49 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.placeholder", "type": "string", + "tags": [], "label": "placeholder", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 50 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.disableLanguageSwitcher", "type": "CompoundType", + "tags": [], "label": "disableLanguageSwitcher", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 51 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.languageSwitcherPopoverAnchorPosition", "type": "CompoundType", + "tags": [], "label": "languageSwitcherPopoverAnchorPosition", "description": [], + "signature": [ + "\"upCenter\" | \"upLeft\" | \"upRight\" | \"downCenter\" | \"downLeft\" | \"downRight\" | \"leftCenter\" | \"leftUp\" | \"leftDown\" | \"rightCenter\" | \"rightUp\" | \"rightDown\" | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 52 }, - "signature": [ - "\"upCenter\" | \"upLeft\" | \"upRight\" | \"downCenter\" | \"downLeft\" | \"downRight\" | \"leftCenter\" | \"leftUp\" | \"leftDown\" | \"rightCenter\" | \"rightUp\" | \"rightDown\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.onBlur", "type": "Function", + "tags": [], "label": "onBlur", "description": [], + "signature": [ + "(() => void) | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 53 }, - "signature": [ - "(() => void) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.onChange", "type": "Function", + "tags": [], "label": "onChange", "description": [], - "source": { - "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 54 - }, "signature": [ "((query: ", { @@ -247,32 +277,36 @@ "text": "Query" }, ") => void) | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 54 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.onChangeQueryInputFocus", "type": "Function", + "tags": [], "label": "onChangeQueryInputFocus", "description": [], + "signature": [ + "((isFocused: boolean) => void) | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 55 }, - "signature": [ - "((isFocused: boolean) => void) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.onSubmit", "type": "Function", + "tags": [], "label": "onSubmit", "description": [], - "source": { - "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 56 - }, "signature": [ "((query: ", { @@ -283,197 +317,219 @@ "text": "Query" }, ") => void) | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.submitOnBlur", "type": "CompoundType", + "tags": [], "label": "submitOnBlur", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 57 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.dataTestSubj", "type": "string", + "tags": [], "label": "dataTestSubj", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 58 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.size", "type": "CompoundType", + "tags": [], "label": "size", "description": [], + "signature": [ + "\"s\" | \"l\" | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 59 }, - "signature": [ - "\"s\" | \"l\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.className", "type": "string", + "tags": [], "label": "className", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 60 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.isInvalid", "type": "CompoundType", + "tags": [], "label": "isInvalid", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 61 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.isClearable", "type": "CompoundType", + "tags": [], "label": "isClearable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 62 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.iconType", "type": "CompoundType", + "tags": [], "label": "iconType", "description": [], + "signature": [ + "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 63 }, - "signature": [ - "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.nonKqlMode", "type": "CompoundType", + "tags": [], "label": "nonKqlMode", "description": [], + "signature": [ + "\"text\" | \"lucene\" | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 69 }, - "signature": [ - "\"text\" | \"lucene\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.nonKqlModeHelpText", "type": "string", + "tags": [], "label": "nonKqlModeHelpText", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 70 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.autoSubmit", "type": "CompoundType", + "tags": [], "label": "autoSubmit", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 74 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.QueryStringInputProps.storageKey", "type": "string", + "tags": [], "label": "storageKey", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "lineNumber": 78 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 42 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternSelectProps", "type": "Type", - "label": "IndexPatternSelectProps", "tags": [], + "label": "IndexPatternSelectProps", "description": [], + "signature": [ + "Pick, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\"> & globalThis.Required, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"placeholder\">> & { onChange: (indexPatternId?: string | undefined) => void; indexPatternId: string; onNoIndexPatterns?: (() => void) | undefined; }" + ], "source": { "path": "src/plugins/data/public/ui/index_pattern_select/index_pattern_select.tsx", "lineNumber": 17 }, - "signature": [ - "Pick, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\"> & globalThis.Required, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"placeholder\">> & { onChange: (indexPatternId?: string | undefined) => void; indexPatternId: string; fieldTypes?: string[] | undefined; onNoIndexPatterns?: (() => void) | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchBar", "type": "CompoundType", + "tags": [], "label": "SearchBar", "description": [], - "source": { - "path": "src/plugins/data/public/ui/search_bar/index.tsx", - "lineNumber": 23 - }, "signature": [ "React.ComponentClass & ReactIntl.InjectedIntlProps>; }" ], + "source": { + "path": "src/plugins/data/public/ui/search_bar/index.tsx", + "lineNumber": 23 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SearchBarProps", "type": "Type", - "label": "SearchBarProps", "tags": [], + "label": "SearchBarProps", "description": [], + "signature": [ + "SearchBarOwnProps & SearchBarInjectedDeps" + ], "source": { "path": "src/plugins/data/public/ui/search_bar/search_bar.tsx", "lineNumber": 80 }, - "signature": [ - "SearchBarOwnProps & SearchBarInjectedDeps" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.StatefulSearchBarProps", "type": "Type", - "label": "StatefulSearchBarProps", "tags": [], + "label": "StatefulSearchBarProps", "description": [], + "signature": [ + "SearchBarOwnProps & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; }" + ], "source": { "path": "src/plugins/data/public/ui/search_bar/create_search_bar.tsx", "lineNumber": 31 }, - "signature": [ - "SearchBarOwnProps & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; }" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/deprecations.mdx b/api_docs/deprecations.mdx new file mode 100644 index 0000000000000..7c1c48d61be23 --- /dev/null +++ b/api_docs/deprecations.mdx @@ -0,0 +1,2424 @@ +--- +id: kibDevDocsDeprecations +slug: /kibana-dev-docs/deprecated-api-list +title: Deprecated API usage +summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. +date: 2021-05-02 +tags: ['contributor', 'dev', 'apidocs', 'kibana'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. +--- + + +## actions + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [audit_logger.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/authorization/audit_logger.ts#L8) | - | +| | [audit_logger.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/authorization/audit_logger.ts#L16) | - | +| | [audit_logger.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/authorization/audit_logger.ts#L18) | - | + + + +## alerting + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [audit_logger.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/authorization/audit_logger.ts#L8) | - | +| | [audit_logger.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/authorization/audit_logger.ts#L21) | - | +| | [audit_logger.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/authorization/audit_logger.ts#L23) | - | +| | [alerts_client_factory.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/alerts_client_factory.test.ts#L24) | - | +| | [alerts_client_factory.test.ts#L90](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/alerts_client_factory.test.ts#L90) | - | + + + +## beatsManagement + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [kibana_database_adapter.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/beats_management/server/lib/adapters/database/kibana_database_adapter.ts#L8) | - | +| | [kibana_database_adapter.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/beats_management/server/lib/adapters/database/kibana_database_adapter.ts#L28) | - | + + + +## canvas + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [state.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/state.ts#L15) | - | +| | [state.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/state.ts#L58) | - | +| | [state.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/target/types/types/state.d.ts#L2) | - | +| | [state.d.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/target/types/types/state.d.ts#L29) | - | +| | [markdown.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts#L10) | - | +| | [markdown.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts#L34) | - | +| | [timefilterControl.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts#L9) | - | +| | [timefilterControl.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts#L21) | - | +| | [pie.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/pie.ts#L15) | - | +| | [pie.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/pie.ts#L78) | - | +| | [progress.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/progress.ts#L10) | - | +| | [progress.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/progress.ts#L43) | - | +| | [repeat_image.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/repeat_image.ts#L11) | - | +| | [repeat_image.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/repeat_image.ts#L33) | - | +| | [index.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/plot/index.ts#L18) | - | +| | [index.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/plot/index.ts#L32) | - | +| | [metric.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/metric.ts#L9) | - | +| | [metric.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/metric.ts#L25) | - | +| | [render.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/render.ts#L9) | - | +| | [render.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/render.ts#L24) | - | +| | [render.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/render.ts#L26) | - | +| | [table.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/table.ts#L9) | - | +| | [table.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/table.ts#L25) | - | +| | [markdown.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/target/types/canvas_plugin_src/functions/browser/markdown.d.ts#L1) | - | +| | [markdown.d.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/target/types/canvas_plugin_src/functions/browser/markdown.d.ts#L13) | - | +| | [query_es_sql.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/lib/query_es_sql.ts#L12) | - | +| | [query_es_sql.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/lib/query_es_sql.ts#L37) | - | +| | [functions.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#L8) | - | +| | [functions.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#L40) | - | + + + +## crossClusterReplication + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [plugin.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#L13) | - | +| | [plugin.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#L69) | - | +| | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/types.ts#L8) | - | +| | [types.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/types.ts#L41) | - | +| | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/target/types/server/types.d.ts#L1) | - | +| | [types.d.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/target/types/server/types.d.ts#L30) | - | +| | [plugin.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#L17) | - | +| | [plugin.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#L36) | - | + + + +## dashboard + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [saved_objects.ts#L16](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#L16) | - | +| | [save_modal.tsx#L14](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#L14) | - | +| | [save_modal.tsx#L145](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#L145) | - | +| | [saved_objects.ts#L13](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#L13) | - | +| | [saved_dashboards.ts#L12](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboards.ts#L12) | - | +| | [saved_dashboards.ts#L31](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboards.ts#L31) | - | +| | [types.ts#L25](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/types.ts#L25) | - | +| | [types.ts#L74](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/types.ts#L74) | - | +| | [plugin.tsx#L42](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#L42) | - | +| | [plugin.tsx#L126](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#L126) | - | +| | [url_generator.ts#L19](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/url_generator.ts#L19) | - | +| | [url_generator.ts#L95](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/url_generator.ts#L95) | - | +| | [saved_objects.ts#L11](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#L11) | - | +| | [saved_dashboard.ts#L10](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L10) | - | +| | [saved_dashboard.ts#L18](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L18) | - | +| | [clone_panel_action.tsx#L14](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#L14) | - | +| | [clone_panel_action.tsx#L98](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#L98) | - | +| | [clone_panel_action.tsx#L126](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#L126) | - | +| | [use_dashboard_state_manager.ts#L23](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/hooks/use_dashboard_state_manager.ts#L23) | - | +| | [use_dashboard_state_manager.ts#L35](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/hooks/use_dashboard_state_manager.ts#L35) | - | + + + +## discover + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [on_save_search.tsx#L11](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/components/top_nav/on_save_search.tsx#L11) | - | +| | [on_save_search.tsx#L133](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/components/top_nav/on_save_search.tsx#L133) | - | +| | [saved_searches.ts#L10](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/saved_searches/saved_searches.ts#L10) | - | +| | [saved_searches.ts#L20](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/saved_searches/saved_searches.ts#L20) | - | +| | [plugin.tsx#L33](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#L33) | - | +| | [plugin.tsx#L88](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#L88) | - | +| | [_saved_search.ts#L9](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/saved_searches/_saved_search.ts#L9) | - | +| | [_saved_search.ts#L61](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/saved_searches/_saved_search.ts#L61) | - | + + + +## embeddable + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [attribute_service.tsx#L13](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L13) | - | +| | [attribute_service.tsx#L167](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L167) | - | + + + +## encryptedSavedObjects + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [audit_logger.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/encrypted_saved_objects/server/audit/audit_logger.ts#L8) | - | +| | [audit_logger.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/encrypted_saved_objects/server/audit/audit_logger.ts#L16) | - | + + + +## fleet + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [plugin.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#L15) | - | +| | [plugin.ts#L189](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#L189) | - | +| | [plugin.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/server/plugin.d.ts#L2) | - | +| | [plugin.d.ts#L83](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/server/plugin.d.ts#L83) | - | + + + +## globalSearch + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [types.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/global_search/server/types.ts#L11) | - | +| | [types.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/global_search/server/types.ts#L73) | - | +| | [types.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/global_search/target/types/server/types.d.ts#L2) | - | +| | [types.d.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/global_search/target/types/server/types.d.ts#L45) | - | + + + +## graph + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [save_modal.tsx#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#L11) | - | +| | [save_modal.tsx#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#L40) | - | + + + +## indexLifecycleManagement + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [plugin.ts#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/server/plugin.ts#L14) | - | +| | [plugin.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/server/plugin.ts#L29) | - | + + + +## indexManagement + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [plugin.ts#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/plugin.ts#L14) | - | +| | [plugin.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/plugin.ts#L42) | - | +| | [types.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L9) | - | +| | [types.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L40) | - | +| | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L1) | - | +| | [types.d.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L25) | - | +| | [types.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L10) | - | +| | [types.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L43) | - | +| | [types.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L50) | - | +| | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L1) | - | +| | [types.d.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L27) | - | +| | [types.d.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L33) | - | + + + +## infra + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [log_entry_categories_analysis.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts#L9) | - | +| | [log_entry_categories_analysis.ts#L139](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts#L139) | - | +| | [log_entry_categories_analysis.ts#L405](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts#L405) | - | +| | [log_entry_categories_analysis.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts#L1) | - | +| | [log_entry_categories_analysis.d.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts#L58) | - | + + + +## licensing + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [types.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/types.ts#L9) | - | +| | [types.ts#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/types.ts#L85) | - | +| | [types.ts#L110](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/types.ts#L110) | - | +| | [plugin.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.ts#L18) | - | +| | [plugin.ts#L109](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.ts#L109) | - | +| | [plugin.ts#L151](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.ts#L151) | - | +| | [plugin.ts#L180](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.ts#L180) | - | +| | [plugin.test.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.test.ts#L18) | - | +| | [plugin.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.test.ts#L33) | - | +| | [types.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/target/types/server/types.d.ts#L2) | - | +| | [types.d.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/target/types/server/types.d.ts#L70) | - | +| | [types.d.ts#L94](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/target/types/server/types.d.ts#L94) | - | +| | [plugin.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.ts#L19) | - | +| | [plugin.ts#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.ts#L102) | - | +| | [plugin.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.ts#L103) | - | +| | [plugin.ts#L111](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.ts#L111) | - | +| | [plugin.ts#L114](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.ts#L114) | - | +| | [plugin.ts#L115](https://github.com/elastic/kibana/tree/master/x-pack/plugins/licensing/server/plugin.ts#L115) | - | + + + +## lists + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [shared_imports.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/shared_imports.ts#L9) | - | +| | [schemas.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.ts#L13) | - | +| | [schemas.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.ts#L55) | - | +| | [schemas.ts#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.ts#L87) | - | +| | [schemas.ts#L366](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.ts#L366) | - | +| | [comment.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.ts#L10) | - | +| | [comment.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.ts#L19) | - | +| | [create_comment.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.ts#L10) | - | +| | [create_comment.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.ts#L17) | - | +| | [update_comment.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.ts#L10) | - | +| | [update_comment.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.ts#L19) | - | +| | [entry_match_any.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.ts#L10) | - | +| | [entry_match_any.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.ts#L20) | - | +| | [entry_match.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.ts#L10) | - | +| | [entry_match.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.ts#L18) | - | +| | [entry_match.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.ts#L21) | - | +| | [entry_exists.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.ts#L10) | - | +| | [entry_exists.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.ts#L18) | - | +| | [entry_list.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.ts#L10) | - | +| | [entry_list.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.ts#L18) | - | +| | [entry_list.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.ts#L19) | - | +| | [entry_nested.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.ts#L10) | - | +| | [entry_nested.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.ts#L20) | - | +| | [entry_match_wildcard.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.ts#L10) | - | +| | [entry_match_wildcard.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.ts#L18) | - | +| | [entry_match_wildcard.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.ts#L21) | - | +| | [entry_match_any.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.ts#L10) | - | +| | [entry_match_any.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.ts#L19) | - | +| | [entry_match.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.ts#L10) | - | +| | [entry_match.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.ts#L18) | - | +| | [entry_match.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.ts#L21) | - | +| | [entry_nested.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.ts#L10) | - | +| | [entry_nested.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.ts#L20) | - | +| | [entry_match_wildcard.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_wildcard.ts#L10) | - | +| | [entry_match_wildcard.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_wildcard.ts#L18) | - | +| | [entry_match_wildcard.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_wildcard.ts#L21) | - | +| | [shared_imports.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/shared_imports.ts#L10) | - | +| | [schemas.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.ts#L13) | - | +| | [schemas.ts#L487](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.ts#L487) | - | +| | [shared_imports.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/shared_imports.ts#L11) | - | +| | [create_endpoint_list_item_schema.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.ts#L25) | - | +| | [create_endpoint_list_item_schema.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.ts#L39) | - | +| | [create_exception_list_item_schema.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.ts#L31) | - | +| | [create_exception_list_item_schema.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.ts#L46) | - | +| | [create_exception_list_schema.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.ts#L24) | - | +| | [create_exception_list_schema.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.ts#L40) | - | +| | [shared_imports.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/shared_imports.ts#L12) | - | +| | [schemas.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.ts#L13) | - | +| | [schemas.ts#L293](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.ts#L293) | - | +| | [shared_imports.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/shared_imports.ts#L13) | - | +| | [create_exception_list_schema.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.ts#L25) | - | +| | [create_exception_list_schema.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.ts#L45) | - | +| | [create_list_schema.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.ts#L12) | - | +| | [create_list_schema.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.ts#L28) | - | +| | [shared_imports.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/shared_imports.ts#L17) | - | +| | [schemas.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L11) | - | +| | [schemas.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L105) | - | +| | [schemas.test.ts#L114](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L114) | - | +| | [schemas.test.ts#L127](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L127) | - | +| | [schemas.test.ts#L140](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L140) | - | +| | [schemas.test.ts#L151](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L151) | - | +| | [schemas.test.ts#L163](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L163) | - | +| | [schemas.test.ts#L172](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L172) | - | +| | [schemas.test.ts#L184](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L184) | - | +| | [schemas.test.ts#L193](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L193) | - | +| | [schemas.test.ts#L205](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L205) | - | +| | [schemas.test.ts#L214](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L214) | - | +| | [schemas.test.ts#L226](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L226) | - | +| | [schemas.test.ts#L235](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L235) | - | +| | [schemas.test.ts#L244](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L244) | - | +| | [schemas.test.ts#L256](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L256) | - | +| | [schemas.test.ts#L265](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L265) | - | +| | [schemas.test.ts#L277](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L277) | - | +| | [schemas.test.ts#L288](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L288) | - | +| | [schemas.test.ts#L301](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L301) | - | +| | [schemas.test.ts#L312](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L312) | - | +| | [schemas.test.ts#L321](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L321) | - | +| | [schemas.test.ts#L333](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L333) | - | +| | [schemas.test.ts#L344](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L344) | - | +| | [schemas.test.ts#L356](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L356) | - | +| | [schemas.test.ts#L367](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L367) | - | +| | [schemas.test.ts#L379](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L379) | - | +| | [schemas.test.ts#L390](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L390) | - | +| | [schemas.test.ts#L399](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L399) | - | +| | [schemas.test.ts#L410](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L410) | - | +| | [search_es_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_item_schema.test.ts#L11) | - | +| | [search_es_list_item_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_item_schema.test.ts#L20) | - | +| | [search_es_list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_item_schema.test.ts#L32) | - | +| | [search_es_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_schema.test.ts#L11) | - | +| | [search_es_list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_schema.test.ts#L20) | - | +| | [search_es_list_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_schema.test.ts#L32) | - | +| | [create_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L11) | - | +| | [create_endpoint_list_item_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L26) | - | +| | [create_endpoint_list_item_schema.test.ts#L38](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L38) | - | +| | [create_endpoint_list_item_schema.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L51) | - | +| | [create_endpoint_list_item_schema.test.ts#L64](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L64) | - | +| | [create_endpoint_list_item_schema.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L78) | - | +| | [create_endpoint_list_item_schema.test.ts#L90](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L90) | - | +| | [create_endpoint_list_item_schema.test.ts#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L102) | - | +| | [create_endpoint_list_item_schema.test.ts#L115](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L115) | - | +| | [create_endpoint_list_item_schema.test.ts#L128](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L128) | - | +| | [create_endpoint_list_item_schema.test.ts#L143](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L143) | - | +| | [create_endpoint_list_item_schema.test.ts#L156](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L156) | - | +| | [create_endpoint_list_item_schema.test.ts#L171](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L171) | - | +| | [create_endpoint_list_item_schema.test.ts#L182](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L182) | - | +| | [create_endpoint_list_item_schema.test.ts#L194](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L194) | - | +| | [create_endpoint_list_item_schema.test.ts#L205](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L205) | - | +| | [create_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L11) | - | +| | [create_exception_list_item_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L26) | - | +| | [create_exception_list_item_schema.test.ts#L38](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L38) | - | +| | [create_exception_list_item_schema.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L51) | - | +| | [create_exception_list_item_schema.test.ts#L64](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L64) | - | +| | [create_exception_list_item_schema.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L77) | - | +| | [create_exception_list_item_schema.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L91) | - | +| | [create_exception_list_item_schema.test.ts#L104](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L104) | - | +| | [create_exception_list_item_schema.test.ts#L117](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L117) | - | +| | [create_exception_list_item_schema.test.ts#L132](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L132) | - | +| | [create_exception_list_item_schema.test.ts#L145](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L145) | - | +| | [create_exception_list_item_schema.test.ts#L160](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L160) | - | +| | [create_exception_list_item_schema.test.ts#L173](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L173) | - | +| | [create_exception_list_item_schema.test.ts#L184](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L184) | - | +| | [create_exception_list_item_schema.test.ts#L196](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L196) | - | +| | [create_exception_list_item_schema.test.ts#L208](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L208) | - | +| | [create_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L11) | - | +| | [create_exception_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L23) | - | +| | [create_exception_list_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L34) | - | +| | [create_exception_list_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L47) | - | +| | [create_exception_list_schema.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L58) | - | +| | [create_exception_list_schema.test.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L70) | - | +| | [create_exception_list_schema.test.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L82) | - | +| | [create_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L11) | - | +| | [create_list_item_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L20) | - | +| | [create_list_item_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L31) | - | +| | [create_list_item_schema.test.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L42) | - | +| | [create_list_item_schema.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L53) | - | +| | [create_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L11) | - | +| | [create_list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L20) | - | +| | [create_list_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L31) | - | +| | [create_list_schema.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L41) | - | +| | [create_list_schema.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L51) | - | +| | [create_list_schema.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L61) | - | +| | [create_list_schema.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L71) | - | +| | [delete_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L11) | - | +| | [delete_endpoint_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L23) | - | +| | [delete_endpoint_list_item_schema.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L37) | - | +| | [delete_endpoint_list_item_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L48) | - | +| | [delete_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L11) | - | +| | [delete_exception_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L23) | - | +| | [delete_exception_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L34) | - | +| | [delete_exception_list_item_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L46) | - | +| | [delete_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L11) | - | +| | [delete_exception_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L23) | - | +| | [delete_exception_list_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L34) | - | +| | [delete_exception_list_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L46) | - | +| | [delete_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_item_schema.test.ts#L11) | - | +| | [delete_list_item_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_item_schema.test.ts#L20) | - | +| | [delete_list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_item_schema.test.ts#L32) | - | +| | [delete_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L11) | - | +| | [delete_list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L20) | - | +| | [delete_list_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L32) | - | +| | [delete_list_schema.test.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L42) | - | +| | [export_exception_list_query_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L11) | - | +| | [export_exception_list_query_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L23) | - | +| | [export_exception_list_query_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L35) | - | +| | [export_exception_list_query_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L46) | - | +| | [export_exception_list_query_schema.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L61) | - | +| | [export_exception_list_query_schema.test.ts#L76](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L76) | - | +| | [export_list_item_query_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L11) | - | +| | [export_list_item_query_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L23) | - | +| | [export_list_item_query_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L35) | - | +| | [export_list_item_query_schema.test.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L49) | - | +| | [find_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L11) | - | +| | [find_endpoint_list_item_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L26) | - | +| | [find_endpoint_list_item_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L35) | - | +| | [find_endpoint_list_item_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L45) | - | +| | [find_endpoint_list_item_schema.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L57) | - | +| | [find_endpoint_list_item_schema.test.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L69) | - | +| | [find_endpoint_list_item_schema.test.ts#L81](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L81) | - | +| | [find_endpoint_list_item_schema.test.ts#L93](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L93) | - | +| | [find_endpoint_list_item_schema.test.ts#L106](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L106) | - | +| | [find_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L11) | - | +| | [find_exception_list_item_schema.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L30) | - | +| | [find_exception_list_item_schema.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L39) | - | +| | [find_exception_list_item_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L48) | - | +| | [find_exception_list_item_schema.test.ts#L67](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L67) | - | +| | [find_exception_list_item_schema.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L79) | - | +| | [find_exception_list_item_schema.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L91) | - | +| | [find_exception_list_item_schema.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L105) | - | +| | [find_exception_list_item_schema.test.ts#L117](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L117) | - | +| | [find_exception_list_item_schema.test.ts#L130](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L130) | - | +| | [find_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L11) | - | +| | [find_exception_list_schema.test.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L27) | - | +| | [find_exception_list_schema.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L36) | - | +| | [find_exception_list_schema.test.ts#L54](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L54) | - | +| | [find_exception_list_schema.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L66) | - | +| | [find_exception_list_schema.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L78) | - | +| | [find_exception_list_schema.test.ts#L90](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L90) | - | +| | [find_exception_list_schema.test.ts#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L102) | - | +| | [find_exception_list_schema.test.ts#L115](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L115) | - | +| | [find_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L11) | - | +| | [find_list_item_schema.test.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L28) | - | +| | [find_list_item_schema.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L37) | - | +| | [find_list_item_schema.test.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L56) | - | +| | [find_list_item_schema.test.ts#L68](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L68) | - | +| | [find_list_item_schema.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L80) | - | +| | [find_list_item_schema.test.ts#L92](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L92) | - | +| | [find_list_item_schema.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L105) | - | +| | [find_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L11) | - | +| | [find_list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L20) | - | +| | [find_list_schema.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L29) | - | +| | [find_list_schema.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L39) | - | +| | [find_list_schema.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L51) | - | +| | [find_list_schema.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L63) | - | +| | [find_list_schema.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L75) | - | +| | [find_list_schema.test.ts#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L87) | - | +| | [find_list_schema.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L100) | - | +| | [import_list_item_query_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L11) | - | +| | [import_list_item_query_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L23) | - | +| | [import_list_item_query_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L34) | - | +| | [import_list_item_query_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L44) | - | +| | [import_list_item_query_schema.test.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L55) | - | +| | [import_list_item_query_schema.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L65) | - | +| | [import_list_item_query_schema.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L75) | - | +| | [import_list_item_query_schema.test.ts#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L87) | - | +| | [import_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L11) | - | +| | [import_list_item_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L20) | - | +| | [import_list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L32) | - | +| | [import_list_item_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L46) | - | +| | [patch_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L11) | - | +| | [patch_list_item_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L20) | - | +| | [patch_list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L32) | - | +| | [patch_list_item_schema.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L43) | - | +| | [patch_list_item_schema.test.ts#L54](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L54) | - | +| | [patch_list_item_schema.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L66) | - | +| | [patch_list_item_schema.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L77) | - | +| | [patch_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L11) | - | +| | [patch_list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L20) | - | +| | [patch_list_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L32) | - | +| | [patch_list_schema.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L43) | - | +| | [patch_list_schema.test.ts#L54](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L54) | - | +| | [patch_list_schema.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L65) | - | +| | [patch_list_schema.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L78) | - | +| | [patch_list_schema.test.ts#L90](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L90) | - | +| | [patch_list_schema.test.ts#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L102) | - | +| | [patch_list_schema.test.ts#L114](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L114) | - | +| | [patch_list_schema.test.ts#L125](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L125) | - | +| | [read_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L11) | - | +| | [read_endpoint_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L23) | - | +| | [read_endpoint_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L34) | - | +| | [read_endpoint_list_item_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L45) | - | +| | [read_endpoint_list_item_schema.test.ts#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L59) | - | +| | [read_endpoint_list_item_schema.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L71) | - | +| | [read_endpoint_list_item_schema.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L84) | - | +| | [read_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L11) | - | +| | [read_exception_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L23) | - | +| | [read_exception_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L34) | - | +| | [read_exception_list_item_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L45) | - | +| | [read_exception_list_item_schema.test.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L56) | - | +| | [read_exception_list_item_schema.test.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L72) | - | +| | [read_exception_list_item_schema.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L84) | - | +| | [read_exception_list_item_schema.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L98) | - | +| | [read_exception_list_item_schema.test.ts#L112](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L112) | - | +| | [read_exception_list_item_schema.test.ts#L125](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L125) | - | +| | [read_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L11) | - | +| | [read_exception_list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L20) | - | +| | [read_exception_list_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L31) | - | +| | [read_exception_list_schema.test.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L42) | - | +| | [read_exception_list_schema.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L53) | - | +| | [read_exception_list_schema.test.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L69) | - | +| | [read_exception_list_schema.test.ts#L81](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L81) | - | +| | [read_exception_list_schema.test.ts#L95](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L95) | - | +| | [read_exception_list_schema.test.ts#L109](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L109) | - | +| | [read_exception_list_schema.test.ts#L122](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L122) | - | +| | [read_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L11) | - | +| | [read_list_item_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L20) | - | +| | [read_list_item_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L31) | - | +| | [read_list_item_schema.test.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L42) | - | +| | [read_list_item_schema.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L53) | - | +| | [read_list_item_schema.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L66) | - | +| | [read_list_item_schema.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L78) | - | +| | [read_list_item_schema.test.ts#L90](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L90) | - | +| | [read_list_item_schema.test.ts#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L102) | - | +| | [read_list_item_schema.test.ts#L113](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L113) | - | +| | [read_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L11) | - | +| | [read_list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L20) | - | +| | [read_list_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L32) | - | +| | [read_list_schema.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L43) | - | +| | [update_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L11) | - | +| | [update_endpoint_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L23) | - | +| | [update_endpoint_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L34) | - | +| | [update_endpoint_list_item_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L47) | - | +| | [update_endpoint_list_item_schema.test.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L60) | - | +| | [update_endpoint_list_item_schema.test.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L74) | - | +| | [update_endpoint_list_item_schema.test.ts#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L85) | - | +| | [update_endpoint_list_item_schema.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L98) | - | +| | [update_endpoint_list_item_schema.test.ts#L111](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L111) | - | +| | [update_endpoint_list_item_schema.test.ts#L125](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L125) | - | +| | [update_endpoint_list_item_schema.test.ts#L137](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L137) | - | +| | [update_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L11) | - | +| | [update_exception_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L23) | - | +| | [update_exception_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L34) | - | +| | [update_exception_list_item_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L47) | - | +| | [update_exception_list_item_schema.test.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L60) | - | +| | [update_exception_list_item_schema.test.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L74) | - | +| | [update_exception_list_item_schema.test.ts#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L85) | - | +| | [update_exception_list_item_schema.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L98) | - | +| | [update_exception_list_item_schema.test.ts#L111](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L111) | - | +| | [update_exception_list_item_schema.test.ts#L125](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L125) | - | +| | [update_exception_list_item_schema.test.ts#L137](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L137) | - | +| | [update_exception_list_item_schema.test.ts#L147](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L147) | - | +| | [update_exception_list_item_schema.test.ts#L159](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L159) | - | +| | [update_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L11) | - | +| | [update_exception_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L23) | - | +| | [update_exception_list_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L34) | - | +| | [update_exception_list_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L47) | - | +| | [update_exception_list_schema.test.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L60) | - | +| | [update_exception_list_schema.test.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L73) | - | +| | [update_exception_list_schema.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L86) | - | +| | [update_exception_list_schema.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L98) | - | +| | [update_exception_list_schema.test.ts#L108](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L108) | - | +| | [update_exception_list_schema.test.ts#L120](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L120) | - | +| | [update_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L11) | - | +| | [update_list_item_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L20) | - | +| | [update_list_item_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L31) | - | +| | [update_list_item_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L44) | - | +| | [update_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L11) | - | +| | [update_list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L20) | - | +| | [update_list_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L31) | - | +| | [update_list_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L44) | - | +| | [acknowledge_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L11) | - | +| | [acknowledge_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L20) | - | +| | [acknowledge_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L31) | - | +| | [acknowledge_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L44) | - | +| | [create_endpoint_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L11) | - | +| | [create_endpoint_list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L20) | - | +| | [create_endpoint_list_schema.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L30) | - | +| | [create_endpoint_list_schema.test.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L42) | - | +| | [create_endpoint_list_schema.test.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L56) | - | +| | [create_endpoint_list_schema.test.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L69) | - | +| | [exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L11) | - | +| | [exception_list_item_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L20) | - | +| | [exception_list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L32) | - | +| | [exception_list_item_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L44) | - | +| | [exception_list_item_schema.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L58) | - | +| | [exception_list_item_schema.test.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L72) | - | +| | [exception_list_item_schema.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L86) | - | +| | [exception_list_item_schema.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L100) | - | +| | [exception_list_item_schema.test.ts#L114](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L114) | - | +| | [exception_list_item_schema.test.ts#L126](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L126) | - | +| | [exception_list_item_schema.test.ts#L139](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L139) | - | +| | [exception_list_item_schema.test.ts#L151](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L151) | - | +| | [exception_list_item_schema.test.ts#L165](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L165) | - | +| | [exception_list_item_schema.test.ts#L179](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L179) | - | +| | [exception_list_item_schema.test.ts#L193](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L193) | - | +| | [exception_list_item_schema.test.ts#L207](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L207) | - | +| | [exception_list_item_schema.test.ts#L221](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L221) | - | +| | [exception_list_item_schema.test.ts#L236](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L236) | - | +| | [exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L11) | - | +| | [exception_list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L20) | - | +| | [exception_list_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L32) | - | +| | [exception_list_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L44) | - | +| | [exception_list_schema.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L58) | - | +| | [exception_list_schema.test.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L72) | - | +| | [exception_list_schema.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L84) | - | +| | [exception_list_schema.test.ts#L97](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L97) | - | +| | [exception_list_schema.test.ts#L109](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L109) | - | +| | [exception_list_schema.test.ts#L123](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L123) | - | +| | [exception_list_schema.test.ts#L137](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L137) | - | +| | [exception_list_schema.test.ts#L151](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L151) | - | +| | [exception_list_schema.test.ts#L165](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L165) | - | +| | [exception_list_schema.test.ts#L179](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L179) | - | +| | [exception_list_schema.test.ts#L194](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L194) | - | +| | [found_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L11) | - | +| | [found_exception_list_item_schema.test.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L25) | - | +| | [found_exception_list_item_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L44) | - | +| | [found_exception_list_item_schema.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L58) | - | +| | [found_exception_list_item_schema.test.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L70) | - | +| | [found_exception_list_item_schema.test.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L82) | - | +| | [found_exception_list_item_schema.test.ts#L94](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L94) | - | +| | [found_exception_list_item_schema.test.ts#L108](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L108) | - | +| | [found_exception_list_item_schema.test.ts#L122](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L122) | - | +| | [found_exception_list_item_schema.test.ts#L136](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L136) | - | +| | [found_exception_list_item_schema.test.ts#L151](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L151) | - | +| | [found_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L11) | - | +| | [found_exception_list_schema.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L22) | - | +| | [found_exception_list_schema.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L41) | - | +| | [found_exception_list_schema.test.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L55) | - | +| | [found_exception_list_schema.test.ts#L67](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L67) | - | +| | [found_exception_list_schema.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L79) | - | +| | [found_exception_list_schema.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L91) | - | +| | [found_exception_list_schema.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L105) | - | +| | [found_exception_list_schema.test.ts#L119](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L119) | - | +| | [found_exception_list_schema.test.ts#L133](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L133) | - | +| | [found_exception_list_schema.test.ts#L148](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L148) | - | +| | [list_item_index_exist_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L11) | - | +| | [list_item_index_exist_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L20) | - | +| | [list_item_index_exist_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L32) | - | +| | [list_item_index_exist_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L46) | - | +| | [list_item_index_exist_schema.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L61) | - | +| | [list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L11) | - | +| | [list_item_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L20) | - | +| | [list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L32) | - | +| | [list_item_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L44) | - | +| | [list_item_schema.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L57) | - | +| | [list_item_schema.test.ts#L68](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L68) | - | +| | [list_item_schema.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L79) | - | +| | [list_item_schema.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L91) | - | +| | [list_item_schema.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L105) | - | +| | [list_item_schema.test.ts#L119](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L119) | - | +| | [list_item_schema.test.ts#L133](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L133) | - | +| | [list_item_schema.test.ts#L147](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L147) | - | +| | [list_item_schema.test.ts#L161](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L161) | - | +| | [list_item_schema.test.ts#L175](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L175) | - | +| | [list_item_schema.test.ts#L188](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L188) | - | +| | [list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L11) | - | +| | [list_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L20) | - | +| | [list_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L32) | - | +| | [list_schema.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L43) | - | +| | [list_schema.test.ts#L54](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L54) | - | +| | [list_schema.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L65) | - | +| | [list_schema.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L77) | - | +| | [list_schema.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L91) | - | +| | [list_schema.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L105) | - | +| | [list_schema.test.ts#L119](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L119) | - | +| | [list_schema.test.ts#L133](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L133) | - | +| | [list_schema.test.ts#L147](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L147) | - | +| | [list_schema.test.ts#L161](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L161) | - | +| | [list_schema.test.ts#L175](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L175) | - | +| | [list_schema.test.ts#L188](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L188) | - | +| | [search_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L11) | - | +| | [search_list_item_schema.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L20) | - | +| | [search_list_item_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L31) | - | +| | [search_list_item_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L44) | - | +| | [encode_decode_cursor.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/server/services/utils/encode_decode_cursor.ts#L13) | - | +| | [encode_decode_cursor.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/server/services/utils/encode_decode_cursor.ts#L77) | - | +| | [validate.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/server/routes/validate.ts#L17) | - | +| | [validate.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/server/routes/validate.ts#L70) | - | +| | [shared_imports.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/shared_imports.ts#L18) | - | +| | [schemas.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L11) | - | +| | [schemas.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L43) | - | +| | [schemas.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L52) | - | +| | [schemas.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L75) | - | +| | [schemas.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L84) | - | +| | [schemas.test.ts#L107](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L107) | - | +| | [schemas.test.ts#L116](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L116) | - | +| | [schemas.test.ts#L129](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L129) | - | +| | [schemas.test.ts#L142](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L142) | - | +| | [schemas.test.ts#L153](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L153) | - | +| | [schemas.test.ts#L165](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L165) | - | +| | [schemas.test.ts#L174](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L174) | - | +| | [schemas.test.ts#L186](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L186) | - | +| | [schemas.test.ts#L195](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L195) | - | +| | [schemas.test.ts#L207](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L207) | - | +| | [schemas.test.ts#L216](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L216) | - | +| | [schemas.test.ts#L228](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L228) | - | +| | [schemas.test.ts#L237](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L237) | - | +| | [schemas.test.ts#L246](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L246) | - | +| | [schemas.test.ts#L258](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L258) | - | +| | [schemas.test.ts#L267](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L267) | - | +| | [schemas.test.ts#L279](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L279) | - | +| | [schemas.test.ts#L290](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L290) | - | +| | [schemas.test.ts#L303](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L303) | - | +| | [schemas.test.ts#L314](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L314) | - | +| | [schemas.test.ts#L323](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L323) | - | +| | [schemas.test.ts#L335](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L335) | - | +| | [schemas.test.ts#L346](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L346) | - | +| | [schemas.test.ts#L358](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L358) | - | +| | [schemas.test.ts#L369](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L369) | - | +| | [schemas.test.ts#L381](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L381) | - | +| | [schemas.test.ts#L392](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L392) | - | +| | [schemas.test.ts#L401](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L401) | - | +| | [schemas.test.ts#L412](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L412) | - | +| | [search_es_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_item_schema.test.ts#L11) | - | +| | [search_es_list_item_schema.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_item_schema.test.ts#L22) | - | +| | [search_es_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_item_schema.test.ts#L34) | - | +| | [search_es_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_schema.test.ts#L11) | - | +| | [search_es_list_schema.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_schema.test.ts#L22) | - | +| | [search_es_list_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_schema.test.ts#L34) | - | +| | [create_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L11) | - | +| | [create_endpoint_list_item_schema.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L29) | - | +| | [create_endpoint_list_item_schema.test.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L40) | - | +| | [create_endpoint_list_item_schema.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L53) | - | +| | [create_endpoint_list_item_schema.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L66) | - | +| | [create_endpoint_list_item_schema.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L80) | - | +| | [create_endpoint_list_item_schema.test.ts#L92](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L92) | - | +| | [create_endpoint_list_item_schema.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L105) | - | +| | [create_endpoint_list_item_schema.test.ts#L118](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L118) | - | +| | [create_endpoint_list_item_schema.test.ts#L131](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L131) | - | +| | [create_endpoint_list_item_schema.test.ts#L145](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L145) | - | +| | [create_endpoint_list_item_schema.test.ts#L159](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L159) | - | +| | [create_endpoint_list_item_schema.test.ts#L174](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L174) | - | +| | [create_endpoint_list_item_schema.test.ts#L184](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L184) | - | +| | [create_endpoint_list_item_schema.test.ts#L207](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L207) | - | +| | [create_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L11) | - | +| | [create_exception_list_item_schema.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L29) | - | +| | [create_exception_list_item_schema.test.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L40) | - | +| | [create_exception_list_item_schema.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L53) | - | +| | [create_exception_list_item_schema.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L66) | - | +| | [create_exception_list_item_schema.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L79) | - | +| | [create_exception_list_item_schema.test.ts#L94](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L94) | - | +| | [create_exception_list_item_schema.test.ts#L107](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L107) | - | +| | [create_exception_list_item_schema.test.ts#L120](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L120) | - | +| | [create_exception_list_item_schema.test.ts#L134](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L134) | - | +| | [create_exception_list_item_schema.test.ts#L148](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L148) | - | +| | [create_exception_list_item_schema.test.ts#L163](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L163) | - | +| | [create_exception_list_item_schema.test.ts#L176](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L176) | - | +| | [create_exception_list_item_schema.test.ts#L186](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L186) | - | +| | [create_exception_list_item_schema.test.ts#L210](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L210) | - | +| | [create_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L11) | - | +| | [create_exception_list_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L26) | - | +| | [create_exception_list_schema.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L37) | - | +| | [create_exception_list_schema.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L50) | - | +| | [create_exception_list_schema.test.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L60) | - | +| | [create_exception_list_schema.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L84) | - | +| | [create_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L11) | - | +| | [create_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L23) | - | +| | [create_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L34) | - | +| | [create_list_item_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L45) | - | +| | [create_list_item_schema.test.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L55) | - | +| | [create_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L11) | - | +| | [create_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L23) | - | +| | [create_list_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L33) | - | +| | [create_list_schema.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L43) | - | +| | [create_list_schema.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L53) | - | +| | [create_list_schema.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L63) | - | +| | [create_list_schema.test.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L73) | - | +| | [delete_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L11) | - | +| | [delete_endpoint_list_item_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L26) | - | +| | [delete_endpoint_list_item_schema.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L39) | - | +| | [delete_endpoint_list_item_schema.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L50) | - | +| | [delete_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L11) | - | +| | [delete_exception_list_item_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L26) | - | +| | [delete_exception_list_item_schema.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L36) | - | +| | [delete_exception_list_item_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L48) | - | +| | [delete_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L11) | - | +| | [delete_exception_list_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L26) | - | +| | [delete_exception_list_schema.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L36) | - | +| | [delete_exception_list_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L48) | - | +| | [delete_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_item_schema.test.ts#L11) | - | +| | [delete_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_item_schema.test.ts#L23) | - | +| | [delete_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_item_schema.test.ts#L34) | - | +| | [delete_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L11) | - | +| | [delete_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L23) | - | +| | [delete_list_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L34) | - | +| | [delete_list_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L44) | - | +| | [export_exception_list_query_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L11) | - | +| | [export_exception_list_query_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L26) | - | +| | [export_exception_list_query_schema.test.ts#L38](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L38) | - | +| | [export_exception_list_query_schema.test.ts#L64](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L64) | - | +| | [export_exception_list_query_schema.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L78) | - | +| | [export_list_item_query_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L11) | - | +| | [export_list_item_query_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L26) | - | +| | [export_list_item_query_schema.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L37) | - | +| | [export_list_item_query_schema.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L51) | - | +| | [find_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L11) | - | +| | [find_endpoint_list_item_schema.test.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L28) | - | +| | [find_endpoint_list_item_schema.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L37) | - | +| | [find_endpoint_list_item_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L47) | - | +| | [find_endpoint_list_item_schema.test.ts#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L59) | - | +| | [find_endpoint_list_item_schema.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L71) | - | +| | [find_endpoint_list_item_schema.test.ts#L83](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L83) | - | +| | [find_endpoint_list_item_schema.test.ts#L95](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L95) | - | +| | [find_endpoint_list_item_schema.test.ts#L108](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L108) | - | +| | [find_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L11) | - | +| | [find_exception_list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L32) | - | +| | [find_exception_list_item_schema.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L41) | - | +| | [find_exception_list_item_schema.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L50) | - | +| | [find_exception_list_item_schema.test.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L69) | - | +| | [find_exception_list_item_schema.test.ts#L81](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L81) | - | +| | [find_exception_list_item_schema.test.ts#L93](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L93) | - | +| | [find_exception_list_item_schema.test.ts#L107](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L107) | - | +| | [find_exception_list_item_schema.test.ts#L119](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L119) | - | +| | [find_exception_list_item_schema.test.ts#L132](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L132) | - | +| | [find_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L11) | - | +| | [find_exception_list_schema.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L29) | - | +| | [find_exception_list_schema.test.ts#L38](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L38) | - | +| | [find_exception_list_schema.test.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L56) | - | +| | [find_exception_list_schema.test.ts#L68](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L68) | - | +| | [find_exception_list_schema.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L80) | - | +| | [find_exception_list_schema.test.ts#L92](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L92) | - | +| | [find_exception_list_schema.test.ts#L104](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L104) | - | +| | [find_exception_list_schema.test.ts#L117](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L117) | - | +| | [find_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L11) | - | +| | [find_list_item_schema.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L30) | - | +| | [find_list_item_schema.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L39) | - | +| | [find_list_item_schema.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L58) | - | +| | [find_list_item_schema.test.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L70) | - | +| | [find_list_item_schema.test.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L82) | - | +| | [find_list_item_schema.test.ts#L94](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L94) | - | +| | [find_list_item_schema.test.ts#L107](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L107) | - | +| | [find_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L11) | - | +| | [find_list_schema.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L22) | - | +| | [find_list_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L31) | - | +| | [find_list_schema.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L41) | - | +| | [find_list_schema.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L53) | - | +| | [find_list_schema.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L65) | - | +| | [find_list_schema.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L77) | - | +| | [find_list_schema.test.ts#L89](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L89) | - | +| | [find_list_schema.test.ts#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L102) | - | +| | [import_list_item_query_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L11) | - | +| | [import_list_item_query_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L26) | - | +| | [import_list_item_query_schema.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L36) | - | +| | [import_list_item_query_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L46) | - | +| | [import_list_item_query_schema.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L57) | - | +| | [import_list_item_query_schema.test.ts#L67](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L67) | - | +| | [import_list_item_query_schema.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L77) | - | +| | [import_list_item_query_schema.test.ts#L89](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L89) | - | +| | [import_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L11) | - | +| | [import_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L23) | - | +| | [import_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L34) | - | +| | [import_list_item_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L48) | - | +| | [patch_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L11) | - | +| | [patch_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L23) | - | +| | [patch_list_item_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L35) | - | +| | [patch_list_item_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L46) | - | +| | [patch_list_item_schema.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L57) | - | +| | [patch_list_item_schema.test.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L69) | - | +| | [patch_list_item_schema.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L79) | - | +| | [patch_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L11) | - | +| | [patch_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L23) | - | +| | [patch_list_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L35) | - | +| | [patch_list_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L46) | - | +| | [patch_list_schema.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L57) | - | +| | [patch_list_schema.test.ts#L68](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L68) | - | +| | [patch_list_schema.test.ts#L81](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L81) | - | +| | [patch_list_schema.test.ts#L93](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L93) | - | +| | [patch_list_schema.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L105) | - | +| | [patch_list_schema.test.ts#L117](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L117) | - | +| | [patch_list_schema.test.ts#L127](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L127) | - | +| | [read_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L11) | - | +| | [read_endpoint_list_item_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L26) | - | +| | [read_endpoint_list_item_schema.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L37) | - | +| | [read_endpoint_list_item_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L48) | - | +| | [read_endpoint_list_item_schema.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L62) | - | +| | [read_endpoint_list_item_schema.test.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L74) | - | +| | [read_endpoint_list_item_schema.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L86) | - | +| | [read_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L11) | - | +| | [read_exception_list_item_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L26) | - | +| | [read_exception_list_item_schema.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L37) | - | +| | [read_exception_list_item_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L48) | - | +| | [read_exception_list_item_schema.test.ts#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L59) | - | +| | [read_exception_list_item_schema.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L75) | - | +| | [read_exception_list_item_schema.test.ts#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L87) | - | +| | [read_exception_list_item_schema.test.ts#L101](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L101) | - | +| | [read_exception_list_item_schema.test.ts#L115](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L115) | - | +| | [read_exception_list_item_schema.test.ts#L127](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L127) | - | +| | [read_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L11) | - | +| | [read_exception_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L23) | - | +| | [read_exception_list_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L34) | - | +| | [read_exception_list_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L45) | - | +| | [read_exception_list_schema.test.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L56) | - | +| | [read_exception_list_schema.test.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L72) | - | +| | [read_exception_list_schema.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L84) | - | +| | [read_exception_list_schema.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L98) | - | +| | [read_exception_list_schema.test.ts#L112](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L112) | - | +| | [read_exception_list_schema.test.ts#L124](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L124) | - | +| | [read_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L11) | - | +| | [read_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L23) | - | +| | [read_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L34) | - | +| | [read_list_item_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L45) | - | +| | [read_list_item_schema.test.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L56) | - | +| | [read_list_item_schema.test.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L69) | - | +| | [read_list_item_schema.test.ts#L81](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L81) | - | +| | [read_list_item_schema.test.ts#L93](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L93) | - | +| | [read_list_item_schema.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L105) | - | +| | [read_list_item_schema.test.ts#L115](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L115) | - | +| | [read_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L11) | - | +| | [read_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L23) | - | +| | [read_list_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L35) | - | +| | [read_list_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L45) | - | +| | [update_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L11) | - | +| | [update_endpoint_list_item_schema.test.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L25) | - | +| | [update_endpoint_list_item_schema.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L36) | - | +| | [update_endpoint_list_item_schema.test.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L49) | - | +| | [update_endpoint_list_item_schema.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L62) | - | +| | [update_endpoint_list_item_schema.test.ts#L76](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L76) | - | +| | [update_endpoint_list_item_schema.test.ts#L88](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L88) | - | +| | [update_endpoint_list_item_schema.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L100) | - | +| | [update_endpoint_list_item_schema.test.ts#L113](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L113) | - | +| | [update_endpoint_list_item_schema.test.ts#L127](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L127) | - | +| | [update_endpoint_list_item_schema.test.ts#L139](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L139) | - | +| | [update_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L11) | - | +| | [update_exception_list_item_schema.test.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L25) | - | +| | [update_exception_list_item_schema.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L36) | - | +| | [update_exception_list_item_schema.test.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L49) | - | +| | [update_exception_list_item_schema.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L62) | - | +| | [update_exception_list_item_schema.test.ts#L76](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L76) | - | +| | [update_exception_list_item_schema.test.ts#L88](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L88) | - | +| | [update_exception_list_item_schema.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L100) | - | +| | [update_exception_list_item_schema.test.ts#L113](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L113) | - | +| | [update_exception_list_item_schema.test.ts#L127](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L127) | - | +| | [update_exception_list_item_schema.test.ts#L139](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L139) | - | +| | [update_exception_list_item_schema.test.ts#L161](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L161) | - | +| | [update_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L11) | - | +| | [update_exception_list_schema.test.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L25) | - | +| | [update_exception_list_schema.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L36) | - | +| | [update_exception_list_schema.test.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L49) | - | +| | [update_exception_list_schema.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L62) | - | +| | [update_exception_list_schema.test.ts#L76](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L76) | - | +| | [update_exception_list_schema.test.ts#L88](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L88) | - | +| | [update_exception_list_schema.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L100) | - | +| | [update_exception_list_schema.test.ts#L122](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L122) | - | +| | [update_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L11) | - | +| | [update_list_item_schema.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L22) | - | +| | [update_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L34) | - | +| | [update_list_item_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L46) | - | +| | [update_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L11) | - | +| | [update_list_schema.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L22) | - | +| | [update_list_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L34) | - | +| | [update_list_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L46) | - | +| | [acknowledge_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L11) | - | +| | [acknowledge_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L23) | - | +| | [acknowledge_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L34) | - | +| | [acknowledge_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L46) | - | +| | [create_endpoint_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L11) | - | +| | [create_endpoint_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L23) | - | +| | [create_endpoint_list_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L33) | - | +| | [create_endpoint_list_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L45) | - | +| | [create_endpoint_list_schema.test.ts#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L59) | - | +| | [create_endpoint_list_schema.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L71) | - | +| | [exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L11) | - | +| | [exception_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L23) | - | +| | [exception_list_item_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L35) | - | +| | [exception_list_item_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L47) | - | +| | [exception_list_item_schema.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L61) | - | +| | [exception_list_item_schema.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L75) | - | +| | [exception_list_item_schema.test.ts#L89](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L89) | - | +| | [exception_list_item_schema.test.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L103) | - | +| | [exception_list_item_schema.test.ts#L117](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L117) | - | +| | [exception_list_item_schema.test.ts#L129](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L129) | - | +| | [exception_list_item_schema.test.ts#L142](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L142) | - | +| | [exception_list_item_schema.test.ts#L154](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L154) | - | +| | [exception_list_item_schema.test.ts#L168](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L168) | - | +| | [exception_list_item_schema.test.ts#L182](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L182) | - | +| | [exception_list_item_schema.test.ts#L196](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L196) | - | +| | [exception_list_item_schema.test.ts#L210](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L210) | - | +| | [exception_list_item_schema.test.ts#L224](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L224) | - | +| | [exception_list_item_schema.test.ts#L238](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L238) | - | +| | [exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L11) | - | +| | [exception_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L23) | - | +| | [exception_list_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L35) | - | +| | [exception_list_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L47) | - | +| | [exception_list_schema.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L61) | - | +| | [exception_list_schema.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L75) | - | +| | [exception_list_schema.test.ts#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L87) | - | +| | [exception_list_schema.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L100) | - | +| | [exception_list_schema.test.ts#L112](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L112) | - | +| | [exception_list_schema.test.ts#L126](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L126) | - | +| | [exception_list_schema.test.ts#L140](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L140) | - | +| | [exception_list_schema.test.ts#L154](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L154) | - | +| | [exception_list_schema.test.ts#L168](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L168) | - | +| | [exception_list_schema.test.ts#L182](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L182) | - | +| | [exception_list_schema.test.ts#L196](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L196) | - | +| | [found_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L11) | - | +| | [found_exception_list_item_schema.test.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L28) | - | +| | [found_exception_list_item_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L47) | - | +| | [found_exception_list_item_schema.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L61) | - | +| | [found_exception_list_item_schema.test.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L73) | - | +| | [found_exception_list_item_schema.test.ts#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L85) | - | +| | [found_exception_list_item_schema.test.ts#L97](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L97) | - | +| | [found_exception_list_item_schema.test.ts#L111](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L111) | - | +| | [found_exception_list_item_schema.test.ts#L125](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L125) | - | +| | [found_exception_list_item_schema.test.ts#L139](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L139) | - | +| | [found_exception_list_item_schema.test.ts#L153](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L153) | - | +| | [found_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L11) | - | +| | [found_exception_list_schema.test.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L25) | - | +| | [found_exception_list_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L44) | - | +| | [found_exception_list_schema.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L58) | - | +| | [found_exception_list_schema.test.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L70) | - | +| | [found_exception_list_schema.test.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L82) | - | +| | [found_exception_list_schema.test.ts#L94](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L94) | - | +| | [found_exception_list_schema.test.ts#L108](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L108) | - | +| | [found_exception_list_schema.test.ts#L122](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L122) | - | +| | [found_exception_list_schema.test.ts#L136](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L136) | - | +| | [found_exception_list_schema.test.ts#L150](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L150) | - | +| | [list_item_index_exist_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L11) | - | +| | [list_item_index_exist_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L23) | - | +| | [list_item_index_exist_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L35) | - | +| | [list_item_index_exist_schema.test.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L49) | - | +| | [list_item_index_exist_schema.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L63) | - | +| | [list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L11) | - | +| | [list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L23) | - | +| | [list_item_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L35) | - | +| | [list_item_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L47) | - | +| | [list_item_schema.test.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L60) | - | +| | [list_item_schema.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L71) | - | +| | [list_item_schema.test.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L82) | - | +| | [list_item_schema.test.ts#L94](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L94) | - | +| | [list_item_schema.test.ts#L108](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L108) | - | +| | [list_item_schema.test.ts#L122](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L122) | - | +| | [list_item_schema.test.ts#L136](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L136) | - | +| | [list_item_schema.test.ts#L150](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L150) | - | +| | [list_item_schema.test.ts#L164](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L164) | - | +| | [list_item_schema.test.ts#L178](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L178) | - | +| | [list_item_schema.test.ts#L190](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L190) | - | +| | [list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L11) | - | +| | [list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L23) | - | +| | [list_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L35) | - | +| | [list_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L46) | - | +| | [list_schema.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L57) | - | +| | [list_schema.test.ts#L68](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L68) | - | +| | [list_schema.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L80) | - | +| | [list_schema.test.ts#L94](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L94) | - | +| | [list_schema.test.ts#L108](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L108) | - | +| | [list_schema.test.ts#L122](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L122) | - | +| | [list_schema.test.ts#L136](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L136) | - | +| | [list_schema.test.ts#L150](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L150) | - | +| | [list_schema.test.ts#L164](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L164) | - | +| | [list_schema.test.ts#L178](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L178) | - | +| | [list_schema.test.ts#L190](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L190) | - | +| | [search_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L11) | - | +| | [search_list_item_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L23) | - | +| | [search_list_item_schema.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L34) | - | +| | [search_list_item_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L46) | - | +| | [comment.test.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L12) | - | +| | [comment.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L31) | - | +| | [comment.test.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L42) | - | +| | [comment.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L53) | - | +| | [comment.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L62) | - | +| | [comment.test.ts#L76](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L76) | - | +| | [comment.test.ts#L88](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L88) | - | +| | [comment.test.ts#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L102) | - | +| | [comment.test.ts#L116](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L116) | - | +| | [comment.test.ts#L130](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L130) | - | +| | [comment.test.ts#L144](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L144) | - | +| | [comment.test.ts#L158](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L158) | - | +| | [comment.test.ts#L169](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L169) | - | +| | [comment.test.ts#L181](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L181) | - | +| | [comment.test.ts#L190](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L190) | - | +| | [comment.test.ts#L201](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L201) | - | +| | [comment.test.ts#L214](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L214) | - | +| | [comment.test.ts#L223](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L223) | - | +| | [comment.test.ts#L232](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L232) | - | +| | [create_comment.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L11) | - | +| | [create_comment.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L30) | - | +| | [create_comment.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L39) | - | +| | [create_comment.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L53) | - | +| | [create_comment.test.ts#L67](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L67) | - | +| | [create_comment.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L78) | - | +| | [create_comment.test.ts#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L87) | - | +| | [create_comment.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L98) | - | +| | [create_comment.test.ts#L111](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L111) | - | +| | [create_comment.test.ts#L120](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L120) | - | +| | [create_comment.test.ts#L129](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L129) | - | +| | [default_comments_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L11) | - | +| | [default_comments_array.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L23) | - | +| | [default_comments_array.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L32) | - | +| | [default_comments_array.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L41) | - | +| | [default_comments_array.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L52) | - | +| | [default_comments_array.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L63) | - | +| | [default_create_comments_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L11) | - | +| | [default_create_comments_array.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L24) | - | +| | [default_create_comments_array.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L33) | - | +| | [default_create_comments_array.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L43) | - | +| | [default_create_comments_array.test.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L56) | - | +| | [default_create_comments_array.test.ts#L67](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L67) | - | +| | [default_create_comments_array.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L78) | - | +| | [default_namespace.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L11) | - | +| | [default_namespace.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L21) | - | +| | [default_namespace.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L30) | - | +| | [default_namespace.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L39) | - | +| | [default_namespace.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L48) | - | +| | [default_namespace.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L57) | - | +| | [default_namespace_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L11) | - | +| | [default_namespace_array.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L21) | - | +| | [default_namespace_array.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L30) | - | +| | [default_namespace_array.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L41) | - | +| | [default_namespace_array.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L50) | - | +| | [default_namespace_array.test.ts#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L59) | - | +| | [default_namespace_array.test.ts#L68](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L68) | - | +| | [default_namespace_array.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L77) | - | +| | [default_namespace_array.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L86) | - | +| | [default_namespace_array.test.ts#L95](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L95) | - | +| | [default_update_comments_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L11) | - | +| | [default_update_comments_array.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L23) | - | +| | [default_update_comments_array.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L32) | - | +| | [default_update_comments_array.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L41) | - | +| | [default_update_comments_array.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L52) | - | +| | [default_update_comments_array.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L63) | - | +| | [empty_string_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L11) | - | +| | [empty_string_array.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L21) | - | +| | [empty_string_array.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L30) | - | +| | [empty_string_array.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L39) | - | +| | [empty_string_array.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L48) | - | +| | [empty_string_array.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L57) | - | +| | [empty_string_array.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L66) | - | +| | [empty_string_array.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L77) | - | +| | [entries.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L11) | - | +| | [entries.test.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L28) | - | +| | [entries.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L37) | - | +| | [entries.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L46) | - | +| | [entries.test.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L55) | - | +| | [entries.test.ts#L64](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L64) | - | +| | [entries.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L80) | - | +| | [entries.test.ts#L89](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L89) | - | +| | [entries.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L98) | - | +| | [entries.test.ts#L107](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L107) | - | +| | [entries.test.ts#L116](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L116) | - | +| | [entries.test.ts#L125](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L125) | - | +| | [entries.test.ts#L136](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L136) | - | +| | [entries.test.ts#L145](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L145) | - | +| | [entry_exists.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L11) | - | +| | [entry_exists.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L22) | - | +| | [entry_exists.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L31) | - | +| | [entry_exists.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L41) | - | +| | [entry_exists.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L53) | - | +| | [entry_exists.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L65) | - | +| | [entry_exists.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L77) | - | +| | [entry_list.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L11) | - | +| | [entry_list.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L22) | - | +| | [entry_list.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L31) | - | +| | [entry_list.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L41) | - | +| | [entry_list.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L53) | - | +| | [entry_list.test.ts#L67](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L67) | - | +| | [entry_list.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L79) | - | +| | [entry_list.test.ts#L93](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L93) | - | +| | [entry_match.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L11) | - | +| | [entry_match.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L22) | - | +| | [entry_match.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L31) | - | +| | [entry_match.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L41) | - | +| | [entry_match.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L53) | - | +| | [entry_match.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L65) | - | +| | [entry_match.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L79) | - | +| | [entry_match.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L91) | - | +| | [entry_match.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L105) | - | +| | [entry_match_any.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L11) | - | +| | [entry_match_any.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L22) | - | +| | [entry_match_any.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L31) | - | +| | [entry_match_any.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L41) | - | +| | [entry_match_any.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L53) | - | +| | [entry_match_any.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L65) | - | +| | [entry_match_any.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L77) | - | +| | [entry_match_any.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L91) | - | +| | [entry_match_any.test.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L103) | - | +| | [entry_match_wildcard.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L11) | - | +| | [entry_match_wildcard.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L22) | - | +| | [entry_match_wildcard.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L31) | - | +| | [entry_match_wildcard.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L41) | - | +| | [entry_match_wildcard.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L53) | - | +| | [entry_match_wildcard.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L65) | - | +| | [entry_match_wildcard.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L79) | - | +| | [entry_match_wildcard.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L91) | - | +| | [entry_match_wildcard.test.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L103) | - | +| | [entry_nested.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L11) | - | +| | [entry_nested.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L24) | - | +| | [entry_nested.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L36) | - | +| | [entry_nested.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L47) | - | +| | [entry_nested.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L58) | - | +| | [entry_nested.test.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L69) | - | +| | [entry_nested.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L80) | - | +| | [entry_nested.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L100) | - | +| | [entry_nested.test.ts#L122](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L122) | - | +| | [non_empty_entries_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L11) | - | +| | [non_empty_entries_array.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L31) | - | +| | [non_empty_entries_array.test.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L42) | - | +| | [non_empty_entries_array.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L53) | - | +| | [non_empty_entries_array.test.ts#L64](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L64) | - | +| | [non_empty_entries_array.test.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L73) | - | +| | [non_empty_entries_array.test.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L82) | - | +| | [non_empty_entries_array.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L91) | - | +| | [non_empty_entries_array.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L100) | - | +| | [non_empty_entries_array.test.ts#L109](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L109) | - | +| | [non_empty_entries_array.test.ts#L118](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L118) | - | +| | [non_empty_entries_array.test.ts#L127](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L127) | - | +| | [non_empty_nested_entries_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L11) | - | +| | [non_empty_nested_entries_array.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L26) | - | +| | [non_empty_nested_entries_array.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L37) | - | +| | [non_empty_nested_entries_array.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L48) | - | +| | [non_empty_nested_entries_array.test.ts#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L59) | - | +| | [non_empty_nested_entries_array.test.ts#L68](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L68) | - | +| | [non_empty_nested_entries_array.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L77) | - | +| | [non_empty_nested_entries_array.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L86) | - | +| | [non_empty_nested_entries_array.test.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L103) | - | +| | [non_empty_nested_entries_array.test.ts#L112](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L112) | - | +| | [non_empty_or_nullable_string_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L11) | - | +| | [non_empty_or_nullable_string_array.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L21) | - | +| | [non_empty_or_nullable_string_array.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L32) | - | +| | [non_empty_or_nullable_string_array.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L43) | - | +| | [non_empty_or_nullable_string_array.test.ts#L54](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L54) | - | +| | [non_empty_or_nullable_string_array.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L65) | - | +| | [non_empty_string_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L11) | - | +| | [non_empty_string_array.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L21) | - | +| | [non_empty_string_array.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L32) | - | +| | [non_empty_string_array.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L43) | - | +| | [non_empty_string_array.test.ts#L54](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L54) | - | +| | [non_empty_string_array.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L63) | - | +| | [non_empty_string_array.test.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L72) | - | +| | [non_empty_string_array.test.ts#L81](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L81) | - | +| | [non_empty_string_array.test.ts#L92](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L92) | - | +| | [update_comment.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L11) | - | +| | [update_comment.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L30) | - | +| | [update_comment.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L41) | - | +| | [update_comment.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L52) | - | +| | [update_comment.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L62) | - | +| | [update_comment.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L71) | - | +| | [update_comment.test.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L82) | - | +| | [update_comment.test.ts#L93](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L93) | - | +| | [update_comment.test.ts#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L102) | - | +| | [update_comment.test.ts#L113](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L113) | - | +| | [update_comment.test.ts#L126](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L126) | - | +| | [update_comment.test.ts#L135](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L135) | - | +| | [update_comment.test.ts#L144](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L144) | - | +| | [entries.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L11) | - | +| | [entries.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L32) | - | +| | [entries.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L41) | - | +| | [entries.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L50) | - | +| | [entries.test.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L73) | - | +| | [entries.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L86) | - | +| | [entries.test.ts#L99](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L99) | - | +| | [entries.test.ts#L108](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L108) | - | +| | [entry_match.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L11) | - | +| | [entry_match.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L23) | - | +| | [entry_match.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L34) | - | +| | [entry_match.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L48) | - | +| | [entry_match.test.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L60) | - | +| | [entry_match.test.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L74) | - | +| | [entry_match.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L86) | - | +| | [entry_match.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L100) | - | +| | [entry_match_any.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L11) | - | +| | [entry_match_any.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L23) | - | +| | [entry_match_any.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L34) | - | +| | [entry_match_any.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L48) | - | +| | [entry_match_any.test.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L60) | - | +| | [entry_match_any.test.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L72) | - | +| | [entry_match_any.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L86) | - | +| | [entry_match_any.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L98) | - | +| | [entry_nested.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L11) | - | +| | [entry_nested.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L29) | - | +| | [entry_nested.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L41) | - | +| | [entry_nested.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L52) | - | +| | [entry_nested.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L63) | - | +| | [entry_nested.test.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L74) | - | +| | [entry_nested.test.ts#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L85) | - | +| | [entry_nested.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L105) | - | +| | [entry_nested.test.ts#L120](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L120) | - | +| | [shared_imports.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/shared_imports.ts#L19) | - | +| | [schemas.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L11) | - | +| | [schemas.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L41) | - | +| | [schemas.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L50) | - | +| | [schemas.test.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L73) | - | +| | [schemas.test.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L82) | - | +| | [schemas.test.ts#L106](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L106) | - | +| | [schemas.test.ts#L115](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L115) | - | +| | [schemas.test.ts#L128](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L128) | - | +| | [schemas.test.ts#L141](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L141) | - | +| | [schemas.test.ts#L152](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L152) | - | +| | [schemas.test.ts#L164](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L164) | - | +| | [schemas.test.ts#L173](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L173) | - | +| | [schemas.test.ts#L185](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L185) | - | +| | [schemas.test.ts#L194](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L194) | - | +| | [schemas.test.ts#L206](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L206) | - | +| | [schemas.test.ts#L215](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L215) | - | +| | [schemas.test.ts#L227](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L227) | - | +| | [schemas.test.ts#L236](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L236) | - | +| | [schemas.test.ts#L245](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L245) | - | +| | [schemas.test.ts#L257](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L257) | - | +| | [schemas.test.ts#L266](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L266) | - | +| | [schemas.test.ts#L278](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L278) | - | +| | [schemas.test.ts#L289](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L289) | - | +| | [schemas.test.ts#L302](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L302) | - | +| | [schemas.test.ts#L313](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L313) | - | +| | [schemas.test.ts#L322](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L322) | - | +| | [schemas.test.ts#L334](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L334) | - | +| | [schemas.test.ts#L345](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L345) | - | +| | [schemas.test.ts#L357](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L357) | - | +| | [schemas.test.ts#L368](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L368) | - | +| | [schemas.test.ts#L380](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L380) | - | +| | [schemas.test.ts#L391](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L391) | - | +| | [schemas.test.ts#L400](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L400) | - | +| | [schemas.test.ts#L411](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/common/schemas.test.ts#L411) | - | +| | [search_es_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_item_schema.test.ts#L11) | - | +| | [search_es_list_item_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_item_schema.test.ts#L21) | - | +| | [search_es_list_item_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_item_schema.test.ts#L33) | - | +| | [search_es_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_schema.test.ts#L11) | - | +| | [search_es_list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_schema.test.ts#L21) | - | +| | [search_es_list_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/elastic_response/search_es_list_schema.test.ts#L33) | - | +| | [create_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L11) | - | +| | [create_endpoint_list_item_schema.test.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L27) | - | +| | [create_endpoint_list_item_schema.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L39) | - | +| | [create_endpoint_list_item_schema.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L52) | - | +| | [create_endpoint_list_item_schema.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L65) | - | +| | [create_endpoint_list_item_schema.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L79) | - | +| | [create_endpoint_list_item_schema.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L91) | - | +| | [create_endpoint_list_item_schema.test.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L103) | - | +| | [create_endpoint_list_item_schema.test.ts#L116](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L116) | - | +| | [create_endpoint_list_item_schema.test.ts#L129](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L129) | - | +| | [create_endpoint_list_item_schema.test.ts#L144](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L144) | - | +| | [create_endpoint_list_item_schema.test.ts#L157](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L157) | - | +| | [create_endpoint_list_item_schema.test.ts#L172](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L172) | - | +| | [create_endpoint_list_item_schema.test.ts#L183](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L183) | - | +| | [create_endpoint_list_item_schema.test.ts#L195](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L195) | - | +| | [create_endpoint_list_item_schema.test.ts#L206](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_endpoint_list_item_schema.test.ts#L206) | - | +| | [create_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L11) | - | +| | [create_exception_list_item_schema.test.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L27) | - | +| | [create_exception_list_item_schema.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L39) | - | +| | [create_exception_list_item_schema.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L52) | - | +| | [create_exception_list_item_schema.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L65) | - | +| | [create_exception_list_item_schema.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L78) | - | +| | [create_exception_list_item_schema.test.ts#L92](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L92) | - | +| | [create_exception_list_item_schema.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L105) | - | +| | [create_exception_list_item_schema.test.ts#L118](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L118) | - | +| | [create_exception_list_item_schema.test.ts#L133](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L133) | - | +| | [create_exception_list_item_schema.test.ts#L146](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L146) | - | +| | [create_exception_list_item_schema.test.ts#L161](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L161) | - | +| | [create_exception_list_item_schema.test.ts#L174](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L174) | - | +| | [create_exception_list_item_schema.test.ts#L185](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L185) | - | +| | [create_exception_list_item_schema.test.ts#L197](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L197) | - | +| | [create_exception_list_item_schema.test.ts#L209](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.test.ts#L209) | - | +| | [create_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L11) | - | +| | [create_exception_list_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L24) | - | +| | [create_exception_list_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L35) | - | +| | [create_exception_list_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L48) | - | +| | [create_exception_list_schema.test.ts#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L59) | - | +| | [create_exception_list_schema.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L71) | - | +| | [create_exception_list_schema.test.ts#L83](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.test.ts#L83) | - | +| | [create_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L11) | - | +| | [create_list_item_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L21) | - | +| | [create_list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L32) | - | +| | [create_list_item_schema.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L43) | - | +| | [create_list_item_schema.test.ts#L54](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_item_schema.test.ts#L54) | - | +| | [create_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L11) | - | +| | [create_list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L21) | - | +| | [create_list_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L32) | - | +| | [create_list_schema.test.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L42) | - | +| | [create_list_schema.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L52) | - | +| | [create_list_schema.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L62) | - | +| | [create_list_schema.test.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/create_list_schema.test.ts#L72) | - | +| | [delete_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L11) | - | +| | [delete_endpoint_list_item_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L24) | - | +| | [delete_endpoint_list_item_schema.test.ts#L38](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L38) | - | +| | [delete_endpoint_list_item_schema.test.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_endpoint_list_item_schema.test.ts#L49) | - | +| | [delete_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L11) | - | +| | [delete_exception_list_item_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L24) | - | +| | [delete_exception_list_item_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L35) | - | +| | [delete_exception_list_item_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_item_schema.test.ts#L47) | - | +| | [delete_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L11) | - | +| | [delete_exception_list_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L24) | - | +| | [delete_exception_list_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L35) | - | +| | [delete_exception_list_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_exception_list_schema.test.ts#L47) | - | +| | [delete_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_item_schema.test.ts#L11) | - | +| | [delete_list_item_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_item_schema.test.ts#L21) | - | +| | [delete_list_item_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_item_schema.test.ts#L33) | - | +| | [delete_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L11) | - | +| | [delete_list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L21) | - | +| | [delete_list_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L33) | - | +| | [delete_list_schema.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/delete_list_schema.test.ts#L43) | - | +| | [export_exception_list_query_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L11) | - | +| | [export_exception_list_query_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L24) | - | +| | [export_exception_list_query_schema.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L36) | - | +| | [export_exception_list_query_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L47) | - | +| | [export_exception_list_query_schema.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L62) | - | +| | [export_exception_list_query_schema.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_exception_list_query_schema.test.ts#L77) | - | +| | [export_list_item_query_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L11) | - | +| | [export_list_item_query_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L24) | - | +| | [export_list_item_query_schema.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L36) | - | +| | [export_list_item_query_schema.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/export_list_item_query_schema.test.ts#L50) | - | +| | [find_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L11) | - | +| | [find_endpoint_list_item_schema.test.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L27) | - | +| | [find_endpoint_list_item_schema.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L36) | - | +| | [find_endpoint_list_item_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L46) | - | +| | [find_endpoint_list_item_schema.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L58) | - | +| | [find_endpoint_list_item_schema.test.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L70) | - | +| | [find_endpoint_list_item_schema.test.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L82) | - | +| | [find_endpoint_list_item_schema.test.ts#L94](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L94) | - | +| | [find_endpoint_list_item_schema.test.ts#L107](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_endpoint_list_item_schema.test.ts#L107) | - | +| | [find_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L11) | - | +| | [find_exception_list_item_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L31) | - | +| | [find_exception_list_item_schema.test.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L40) | - | +| | [find_exception_list_item_schema.test.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L49) | - | +| | [find_exception_list_item_schema.test.ts#L68](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L68) | - | +| | [find_exception_list_item_schema.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L80) | - | +| | [find_exception_list_item_schema.test.ts#L92](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L92) | - | +| | [find_exception_list_item_schema.test.ts#L106](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L106) | - | +| | [find_exception_list_item_schema.test.ts#L118](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L118) | - | +| | [find_exception_list_item_schema.test.ts#L131](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_item_schema.test.ts#L131) | - | +| | [find_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L11) | - | +| | [find_exception_list_schema.test.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L28) | - | +| | [find_exception_list_schema.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L37) | - | +| | [find_exception_list_schema.test.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L55) | - | +| | [find_exception_list_schema.test.ts#L67](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L67) | - | +| | [find_exception_list_schema.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L79) | - | +| | [find_exception_list_schema.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L91) | - | +| | [find_exception_list_schema.test.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L103) | - | +| | [find_exception_list_schema.test.ts#L116](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_exception_list_schema.test.ts#L116) | - | +| | [find_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L11) | - | +| | [find_list_item_schema.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L29) | - | +| | [find_list_item_schema.test.ts#L38](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L38) | - | +| | [find_list_item_schema.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L57) | - | +| | [find_list_item_schema.test.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L69) | - | +| | [find_list_item_schema.test.ts#L81](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L81) | - | +| | [find_list_item_schema.test.ts#L93](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L93) | - | +| | [find_list_item_schema.test.ts#L106](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_item_schema.test.ts#L106) | - | +| | [find_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L11) | - | +| | [find_list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L21) | - | +| | [find_list_schema.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L30) | - | +| | [find_list_schema.test.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L40) | - | +| | [find_list_schema.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L52) | - | +| | [find_list_schema.test.ts#L64](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L64) | - | +| | [find_list_schema.test.ts#L76](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L76) | - | +| | [find_list_schema.test.ts#L88](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L88) | - | +| | [find_list_schema.test.ts#L101](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/find_list_schema.test.ts#L101) | - | +| | [import_list_item_query_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L11) | - | +| | [import_list_item_query_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L24) | - | +| | [import_list_item_query_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L35) | - | +| | [import_list_item_query_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L45) | - | +| | [import_list_item_query_schema.test.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L56) | - | +| | [import_list_item_query_schema.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L66) | - | +| | [import_list_item_query_schema.test.ts#L76](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L76) | - | +| | [import_list_item_query_schema.test.ts#L88](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_query_schema.test.ts#L88) | - | +| | [import_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L11) | - | +| | [import_list_item_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L21) | - | +| | [import_list_item_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L33) | - | +| | [import_list_item_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/import_list_item_schema.test.ts#L47) | - | +| | [patch_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L11) | - | +| | [patch_list_item_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L21) | - | +| | [patch_list_item_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L33) | - | +| | [patch_list_item_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L44) | - | +| | [patch_list_item_schema.test.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L55) | - | +| | [patch_list_item_schema.test.ts#L67](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L67) | - | +| | [patch_list_item_schema.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_item_schema.test.ts#L78) | - | +| | [patch_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L11) | - | +| | [patch_list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L21) | - | +| | [patch_list_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L33) | - | +| | [patch_list_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L44) | - | +| | [patch_list_schema.test.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L55) | - | +| | [patch_list_schema.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L66) | - | +| | [patch_list_schema.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L79) | - | +| | [patch_list_schema.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L91) | - | +| | [patch_list_schema.test.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L103) | - | +| | [patch_list_schema.test.ts#L115](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L115) | - | +| | [patch_list_schema.test.ts#L126](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/patch_list_schema.test.ts#L126) | - | +| | [read_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L11) | - | +| | [read_endpoint_list_item_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L24) | - | +| | [read_endpoint_list_item_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L35) | - | +| | [read_endpoint_list_item_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L46) | - | +| | [read_endpoint_list_item_schema.test.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L60) | - | +| | [read_endpoint_list_item_schema.test.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L72) | - | +| | [read_endpoint_list_item_schema.test.ts#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_endpoint_list_item_schema.test.ts#L85) | - | +| | [read_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L11) | - | +| | [read_exception_list_item_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L24) | - | +| | [read_exception_list_item_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L35) | - | +| | [read_exception_list_item_schema.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L46) | - | +| | [read_exception_list_item_schema.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L57) | - | +| | [read_exception_list_item_schema.test.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L73) | - | +| | [read_exception_list_item_schema.test.ts#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L85) | - | +| | [read_exception_list_item_schema.test.ts#L99](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L99) | - | +| | [read_exception_list_item_schema.test.ts#L113](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L113) | - | +| | [read_exception_list_item_schema.test.ts#L126](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_item_schema.test.ts#L126) | - | +| | [read_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L11) | - | +| | [read_exception_list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L21) | - | +| | [read_exception_list_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L32) | - | +| | [read_exception_list_schema.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L43) | - | +| | [read_exception_list_schema.test.ts#L54](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L54) | - | +| | [read_exception_list_schema.test.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L70) | - | +| | [read_exception_list_schema.test.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L82) | - | +| | [read_exception_list_schema.test.ts#L96](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L96) | - | +| | [read_exception_list_schema.test.ts#L110](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L110) | - | +| | [read_exception_list_schema.test.ts#L123](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_exception_list_schema.test.ts#L123) | - | +| | [read_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L11) | - | +| | [read_list_item_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L21) | - | +| | [read_list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L32) | - | +| | [read_list_item_schema.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L43) | - | +| | [read_list_item_schema.test.ts#L54](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L54) | - | +| | [read_list_item_schema.test.ts#L67](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L67) | - | +| | [read_list_item_schema.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L79) | - | +| | [read_list_item_schema.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L91) | - | +| | [read_list_item_schema.test.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L103) | - | +| | [read_list_item_schema.test.ts#L114](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_item_schema.test.ts#L114) | - | +| | [read_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L11) | - | +| | [read_list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L21) | - | +| | [read_list_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L33) | - | +| | [read_list_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/read_list_schema.test.ts#L44) | - | +| | [update_endpoint_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L11) | - | +| | [update_endpoint_list_item_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L24) | - | +| | [update_endpoint_list_item_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L35) | - | +| | [update_endpoint_list_item_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L48) | - | +| | [update_endpoint_list_item_schema.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L61) | - | +| | [update_endpoint_list_item_schema.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L75) | - | +| | [update_endpoint_list_item_schema.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L86) | - | +| | [update_endpoint_list_item_schema.test.ts#L99](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L99) | - | +| | [update_endpoint_list_item_schema.test.ts#L112](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L112) | - | +| | [update_endpoint_list_item_schema.test.ts#L126](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L126) | - | +| | [update_endpoint_list_item_schema.test.ts#L138](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_endpoint_list_item_schema.test.ts#L138) | - | +| | [update_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L11) | - | +| | [update_exception_list_item_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L24) | - | +| | [update_exception_list_item_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L35) | - | +| | [update_exception_list_item_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L48) | - | +| | [update_exception_list_item_schema.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L61) | - | +| | [update_exception_list_item_schema.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L75) | - | +| | [update_exception_list_item_schema.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L86) | - | +| | [update_exception_list_item_schema.test.ts#L99](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L99) | - | +| | [update_exception_list_item_schema.test.ts#L112](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L112) | - | +| | [update_exception_list_item_schema.test.ts#L126](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L126) | - | +| | [update_exception_list_item_schema.test.ts#L138](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L138) | - | +| | [update_exception_list_item_schema.test.ts#L148](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L148) | - | +| | [update_exception_list_item_schema.test.ts#L160](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.test.ts#L160) | - | +| | [update_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L11) | - | +| | [update_exception_list_schema.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L24) | - | +| | [update_exception_list_schema.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L35) | - | +| | [update_exception_list_schema.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L48) | - | +| | [update_exception_list_schema.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L61) | - | +| | [update_exception_list_schema.test.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L74) | - | +| | [update_exception_list_schema.test.ts#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L87) | - | +| | [update_exception_list_schema.test.ts#L99](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L99) | - | +| | [update_exception_list_schema.test.ts#L109](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L109) | - | +| | [update_exception_list_schema.test.ts#L121](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.test.ts#L121) | - | +| | [update_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L11) | - | +| | [update_list_item_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L21) | - | +| | [update_list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L32) | - | +| | [update_list_item_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_item_schema.test.ts#L45) | - | +| | [update_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L11) | - | +| | [update_list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L21) | - | +| | [update_list_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L32) | - | +| | [update_list_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/request/update_list_schema.test.ts#L45) | - | +| | [acknowledge_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L11) | - | +| | [acknowledge_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L21) | - | +| | [acknowledge_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L32) | - | +| | [acknowledge_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/acknowledge_schema.test.ts#L45) | - | +| | [create_endpoint_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L11) | - | +| | [create_endpoint_list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L21) | - | +| | [create_endpoint_list_schema.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L31) | - | +| | [create_endpoint_list_schema.test.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L43) | - | +| | [create_endpoint_list_schema.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L57) | - | +| | [create_endpoint_list_schema.test.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/create_endpoint_list_schema.test.ts#L70) | - | +| | [exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L11) | - | +| | [exception_list_item_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L21) | - | +| | [exception_list_item_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L33) | - | +| | [exception_list_item_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L45) | - | +| | [exception_list_item_schema.test.ts#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L59) | - | +| | [exception_list_item_schema.test.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L73) | - | +| | [exception_list_item_schema.test.ts#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L87) | - | +| | [exception_list_item_schema.test.ts#L101](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L101) | - | +| | [exception_list_item_schema.test.ts#L115](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L115) | - | +| | [exception_list_item_schema.test.ts#L127](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L127) | - | +| | [exception_list_item_schema.test.ts#L140](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L140) | - | +| | [exception_list_item_schema.test.ts#L152](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L152) | - | +| | [exception_list_item_schema.test.ts#L166](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L166) | - | +| | [exception_list_item_schema.test.ts#L180](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L180) | - | +| | [exception_list_item_schema.test.ts#L194](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L194) | - | +| | [exception_list_item_schema.test.ts#L208](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L208) | - | +| | [exception_list_item_schema.test.ts#L222](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L222) | - | +| | [exception_list_item_schema.test.ts#L237](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.test.ts#L237) | - | +| | [exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L11) | - | +| | [exception_list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L21) | - | +| | [exception_list_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L33) | - | +| | [exception_list_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L45) | - | +| | [exception_list_schema.test.ts#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L59) | - | +| | [exception_list_schema.test.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L73) | - | +| | [exception_list_schema.test.ts#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L85) | - | +| | [exception_list_schema.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L98) | - | +| | [exception_list_schema.test.ts#L110](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L110) | - | +| | [exception_list_schema.test.ts#L124](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L124) | - | +| | [exception_list_schema.test.ts#L138](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L138) | - | +| | [exception_list_schema.test.ts#L152](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L152) | - | +| | [exception_list_schema.test.ts#L166](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L166) | - | +| | [exception_list_schema.test.ts#L180](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L180) | - | +| | [exception_list_schema.test.ts#L195](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/exception_list_schema.test.ts#L195) | - | +| | [found_exception_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L11) | - | +| | [found_exception_list_item_schema.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L26) | - | +| | [found_exception_list_item_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L45) | - | +| | [found_exception_list_item_schema.test.ts#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L59) | - | +| | [found_exception_list_item_schema.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L71) | - | +| | [found_exception_list_item_schema.test.ts#L83](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L83) | - | +| | [found_exception_list_item_schema.test.ts#L95](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L95) | - | +| | [found_exception_list_item_schema.test.ts#L109](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L109) | - | +| | [found_exception_list_item_schema.test.ts#L123](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L123) | - | +| | [found_exception_list_item_schema.test.ts#L137](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L137) | - | +| | [found_exception_list_item_schema.test.ts#L152](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_item_schema.test.ts#L152) | - | +| | [found_exception_list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L11) | - | +| | [found_exception_list_schema.test.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L23) | - | +| | [found_exception_list_schema.test.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L42) | - | +| | [found_exception_list_schema.test.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L56) | - | +| | [found_exception_list_schema.test.ts#L68](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L68) | - | +| | [found_exception_list_schema.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L80) | - | +| | [found_exception_list_schema.test.ts#L92](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L92) | - | +| | [found_exception_list_schema.test.ts#L106](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L106) | - | +| | [found_exception_list_schema.test.ts#L120](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L120) | - | +| | [found_exception_list_schema.test.ts#L134](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L134) | - | +| | [found_exception_list_schema.test.ts#L149](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/found_exception_list_schema.test.ts#L149) | - | +| | [list_item_index_exist_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L11) | - | +| | [list_item_index_exist_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L21) | - | +| | [list_item_index_exist_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L33) | - | +| | [list_item_index_exist_schema.test.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L47) | - | +| | [list_item_index_exist_schema.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_index_exist_schema.test.ts#L62) | - | +| | [list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L11) | - | +| | [list_item_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L21) | - | +| | [list_item_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L33) | - | +| | [list_item_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L45) | - | +| | [list_item_schema.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L58) | - | +| | [list_item_schema.test.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L69) | - | +| | [list_item_schema.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L80) | - | +| | [list_item_schema.test.ts#L92](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L92) | - | +| | [list_item_schema.test.ts#L106](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L106) | - | +| | [list_item_schema.test.ts#L120](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L120) | - | +| | [list_item_schema.test.ts#L134](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L134) | - | +| | [list_item_schema.test.ts#L148](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L148) | - | +| | [list_item_schema.test.ts#L162](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L162) | - | +| | [list_item_schema.test.ts#L176](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L176) | - | +| | [list_item_schema.test.ts#L189](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_item_schema.test.ts#L189) | - | +| | [list_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L11) | - | +| | [list_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L21) | - | +| | [list_schema.test.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L33) | - | +| | [list_schema.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L44) | - | +| | [list_schema.test.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L55) | - | +| | [list_schema.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L66) | - | +| | [list_schema.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L78) | - | +| | [list_schema.test.ts#L92](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L92) | - | +| | [list_schema.test.ts#L106](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L106) | - | +| | [list_schema.test.ts#L120](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L120) | - | +| | [list_schema.test.ts#L134](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L134) | - | +| | [list_schema.test.ts#L148](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L148) | - | +| | [list_schema.test.ts#L162](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L162) | - | +| | [list_schema.test.ts#L176](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L176) | - | +| | [list_schema.test.ts#L189](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/list_schema.test.ts#L189) | - | +| | [search_list_item_schema.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L11) | - | +| | [search_list_item_schema.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L21) | - | +| | [search_list_item_schema.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L32) | - | +| | [search_list_item_schema.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/response/search_list_item_schema.test.ts#L45) | - | +| | [comment.test.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L12) | - | +| | [comment.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L29) | - | +| | [comment.test.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L40) | - | +| | [comment.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L51) | - | +| | [comment.test.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L60) | - | +| | [comment.test.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L74) | - | +| | [comment.test.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L86) | - | +| | [comment.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L100) | - | +| | [comment.test.ts#L114](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L114) | - | +| | [comment.test.ts#L128](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L128) | - | +| | [comment.test.ts#L142](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L142) | - | +| | [comment.test.ts#L156](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L156) | - | +| | [comment.test.ts#L167](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L167) | - | +| | [comment.test.ts#L179](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L179) | - | +| | [comment.test.ts#L188](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L188) | - | +| | [comment.test.ts#L199](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L199) | - | +| | [comment.test.ts#L212](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L212) | - | +| | [comment.test.ts#L221](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L221) | - | +| | [comment.test.ts#L230](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/comment.test.ts#L230) | - | +| | [create_comment.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L11) | - | +| | [create_comment.test.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L28) | - | +| | [create_comment.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L37) | - | +| | [create_comment.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L51) | - | +| | [create_comment.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L65) | - | +| | [create_comment.test.ts#L76](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L76) | - | +| | [create_comment.test.ts#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L85) | - | +| | [create_comment.test.ts#L96](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L96) | - | +| | [create_comment.test.ts#L109](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L109) | - | +| | [create_comment.test.ts#L118](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L118) | - | +| | [create_comment.test.ts#L127](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/create_comment.test.ts#L127) | - | +| | [default_comments_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L11) | - | +| | [default_comments_array.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L21) | - | +| | [default_comments_array.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L30) | - | +| | [default_comments_array.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L39) | - | +| | [default_comments_array.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L50) | - | +| | [default_comments_array.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_comments_array.test.ts#L61) | - | +| | [default_create_comments_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L11) | - | +| | [default_create_comments_array.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L22) | - | +| | [default_create_comments_array.test.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L31) | - | +| | [default_create_comments_array.test.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L40) | - | +| | [default_create_comments_array.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L53) | - | +| | [default_create_comments_array.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L65) | - | +| | [default_create_comments_array.test.ts#L76](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_create_comments_array.test.ts#L76) | - | +| | [default_namespace.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L11) | - | +| | [default_namespace.test.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L19) | - | +| | [default_namespace.test.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L28) | - | +| | [default_namespace.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L37) | - | +| | [default_namespace.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L46) | - | +| | [default_namespace.test.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace.test.ts#L55) | - | +| | [default_namespace_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L11) | - | +| | [default_namespace_array.test.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L19) | - | +| | [default_namespace_array.test.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L28) | - | +| | [default_namespace_array.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L39) | - | +| | [default_namespace_array.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L48) | - | +| | [default_namespace_array.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L57) | - | +| | [default_namespace_array.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L66) | - | +| | [default_namespace_array.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L75) | - | +| | [default_namespace_array.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L84) | - | +| | [default_namespace_array.test.ts#L93](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_namespace_array.test.ts#L93) | - | +| | [default_update_comments_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L11) | - | +| | [default_update_comments_array.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L21) | - | +| | [default_update_comments_array.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L30) | - | +| | [default_update_comments_array.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L39) | - | +| | [default_update_comments_array.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L50) | - | +| | [default_update_comments_array.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/default_update_comments_array.test.ts#L61) | - | +| | [empty_string_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L11) | - | +| | [empty_string_array.test.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L19) | - | +| | [empty_string_array.test.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L28) | - | +| | [empty_string_array.test.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L37) | - | +| | [empty_string_array.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L46) | - | +| | [empty_string_array.test.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L55) | - | +| | [empty_string_array.test.ts#L64](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L64) | - | +| | [empty_string_array.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/empty_string_array.test.ts#L75) | - | +| | [entries.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L11) | - | +| | [entries.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L26) | - | +| | [entries.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L35) | - | +| | [entries.test.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L44) | - | +| | [entries.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L53) | - | +| | [entries.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L62) | - | +| | [entries.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L78) | - | +| | [entries.test.ts#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L87) | - | +| | [entries.test.ts#L96](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L96) | - | +| | [entries.test.ts#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L105) | - | +| | [entries.test.ts#L114](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L114) | - | +| | [entries.test.ts#L123](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L123) | - | +| | [entries.test.ts#L134](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L134) | - | +| | [entries.test.ts#L143](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entries.test.ts#L143) | - | +| | [entry_exists.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L11) | - | +| | [entry_exists.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L20) | - | +| | [entry_exists.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L29) | - | +| | [entry_exists.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L39) | - | +| | [entry_exists.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L51) | - | +| | [entry_exists.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L63) | - | +| | [entry_exists.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_exists.test.ts#L75) | - | +| | [entry_list.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L11) | - | +| | [entry_list.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L20) | - | +| | [entry_list.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L29) | - | +| | [entry_list.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L39) | - | +| | [entry_list.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L51) | - | +| | [entry_list.test.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L65) | - | +| | [entry_list.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L77) | - | +| | [entry_list.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_list.test.ts#L91) | - | +| | [entry_match.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L11) | - | +| | [entry_match.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L20) | - | +| | [entry_match.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L29) | - | +| | [entry_match.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L39) | - | +| | [entry_match.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L51) | - | +| | [entry_match.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L63) | - | +| | [entry_match.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L77) | - | +| | [entry_match.test.ts#L89](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L89) | - | +| | [entry_match.test.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match.test.ts#L103) | - | +| | [entry_match_any.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L11) | - | +| | [entry_match_any.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L20) | - | +| | [entry_match_any.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L29) | - | +| | [entry_match_any.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L39) | - | +| | [entry_match_any.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L51) | - | +| | [entry_match_any.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L63) | - | +| | [entry_match_any.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L75) | - | +| | [entry_match_any.test.ts#L89](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L89) | - | +| | [entry_match_any.test.ts#L101](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_any.test.ts#L101) | - | +| | [entry_match_wildcard.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L11) | - | +| | [entry_match_wildcard.test.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L20) | - | +| | [entry_match_wildcard.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L29) | - | +| | [entry_match_wildcard.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L39) | - | +| | [entry_match_wildcard.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L51) | - | +| | [entry_match_wildcard.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L63) | - | +| | [entry_match_wildcard.test.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L77) | - | +| | [entry_match_wildcard.test.ts#L89](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L89) | - | +| | [entry_match_wildcard.test.ts#L101](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.test.ts#L101) | - | +| | [entry_nested.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L11) | - | +| | [entry_nested.test.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L22) | - | +| | [entry_nested.test.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L34) | - | +| | [entry_nested.test.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L45) | - | +| | [entry_nested.test.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L56) | - | +| | [entry_nested.test.ts#L67](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L67) | - | +| | [entry_nested.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L78) | - | +| | [entry_nested.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L98) | - | +| | [entry_nested.test.ts#L120](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/entry_nested.test.ts#L120) | - | +| | [non_empty_entries_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L11) | - | +| | [non_empty_entries_array.test.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L29) | - | +| | [non_empty_entries_array.test.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L40) | - | +| | [non_empty_entries_array.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L51) | - | +| | [non_empty_entries_array.test.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L62) | - | +| | [non_empty_entries_array.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L71) | - | +| | [non_empty_entries_array.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L80) | - | +| | [non_empty_entries_array.test.ts#L89](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L89) | - | +| | [non_empty_entries_array.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L98) | - | +| | [non_empty_entries_array.test.ts#L107](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L107) | - | +| | [non_empty_entries_array.test.ts#L116](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L116) | - | +| | [non_empty_entries_array.test.ts#L125](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_entries_array.test.ts#L125) | - | +| | [non_empty_nested_entries_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L11) | - | +| | [non_empty_nested_entries_array.test.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L24) | - | +| | [non_empty_nested_entries_array.test.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L35) | - | +| | [non_empty_nested_entries_array.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L46) | - | +| | [non_empty_nested_entries_array.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L57) | - | +| | [non_empty_nested_entries_array.test.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L66) | - | +| | [non_empty_nested_entries_array.test.ts#L75](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L75) | - | +| | [non_empty_nested_entries_array.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L84) | - | +| | [non_empty_nested_entries_array.test.ts#L101](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L101) | - | +| | [non_empty_nested_entries_array.test.ts#L110](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.test.ts#L110) | - | +| | [non_empty_or_nullable_string_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L11) | - | +| | [non_empty_or_nullable_string_array.test.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L19) | - | +| | [non_empty_or_nullable_string_array.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L30) | - | +| | [non_empty_or_nullable_string_array.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L41) | - | +| | [non_empty_or_nullable_string_array.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L52) | - | +| | [non_empty_or_nullable_string_array.test.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_or_nullable_string_array.test.ts#L63) | - | +| | [non_empty_string_array.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L11) | - | +| | [non_empty_string_array.test.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L19) | - | +| | [non_empty_string_array.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L30) | - | +| | [non_empty_string_array.test.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L41) | - | +| | [non_empty_string_array.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L52) | - | +| | [non_empty_string_array.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L61) | - | +| | [non_empty_string_array.test.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L70) | - | +| | [non_empty_string_array.test.ts#L79](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L79) | - | +| | [non_empty_string_array.test.ts#L90](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/non_empty_string_array.test.ts#L90) | - | +| | [update_comment.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L11) | - | +| | [update_comment.test.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L28) | - | +| | [update_comment.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L39) | - | +| | [update_comment.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L50) | - | +| | [update_comment.test.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L60) | - | +| | [update_comment.test.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L69) | - | +| | [update_comment.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L80) | - | +| | [update_comment.test.ts#L91](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L91) | - | +| | [update_comment.test.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L100) | - | +| | [update_comment.test.ts#L111](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L111) | - | +| | [update_comment.test.ts#L124](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L124) | - | +| | [update_comment.test.ts#L133](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L133) | - | +| | [update_comment.test.ts#L142](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/update_comment.test.ts#L142) | - | +| | [entries.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L11) | - | +| | [entries.test.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L30) | - | +| | [entries.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L39) | - | +| | [entries.test.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L48) | - | +| | [entries.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L71) | - | +| | [entries.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L84) | - | +| | [entries.test.ts#L97](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L97) | - | +| | [entries.test.ts#L106](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entries.test.ts#L106) | - | +| | [entry_match.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L11) | - | +| | [entry_match.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L21) | - | +| | [entry_match.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L32) | - | +| | [entry_match.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L46) | - | +| | [entry_match.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L58) | - | +| | [entry_match.test.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L72) | - | +| | [entry_match.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L84) | - | +| | [entry_match.test.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match.test.ts#L98) | - | +| | [entry_match_any.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L11) | - | +| | [entry_match_any.test.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L21) | - | +| | [entry_match_any.test.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L32) | - | +| | [entry_match_any.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L46) | - | +| | [entry_match_any.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L58) | - | +| | [entry_match_any.test.ts#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L70) | - | +| | [entry_match_any.test.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L84) | - | +| | [entry_match_any.test.ts#L96](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_match_any.test.ts#L96) | - | +| | [entry_nested.test.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L11) | - | +| | [entry_nested.test.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L27) | - | +| | [entry_nested.test.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L39) | - | +| | [entry_nested.test.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L50) | - | +| | [entry_nested.test.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L61) | - | +| | [entry_nested.test.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L72) | - | +| | [entry_nested.test.ts#L83](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L83) | - | +| | [entry_nested.test.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L103) | - | +| | [entry_nested.test.ts#L118](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/schemas/types/endpoint/entry_nested.test.ts#L118) | - | +| | [shared_imports.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/shared_imports.ts#L22) | - | +| | [siem_server_deps.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/server/siem_server_deps.ts#L24) | - | +| | [validate.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/server/routes/validate.ts#L18) | - | +| | [validate.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/server/routes/validate.ts#L74) | - | +| | [get_call_cluster.mock.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/get_call_cluster.mock.ts#L9) | - | +| | [get_call_cluster.mock.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/get_call_cluster.mock.ts#L26) | - | +| | [get_call_cluster.mock.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/common/get_call_cluster.mock.ts#L30) | - | + + + +## monitoring + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [types.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/types.ts#L11) | - | +| | [types.ts#L90](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/types.ts#L90) | - | +| | [get_usage_collector.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_usage_collector.ts#L9) | - | +| | [get_usage_collector.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_usage_collector.ts#L22) | - | +| | [index.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/index.ts#L8) | - | +| | [index.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/index.ts#L19) | - | +| | [register_monitoring_telemetry_collection.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/register_monitoring_telemetry_collection.ts#L8) | - | +| | [register_monitoring_telemetry_collection.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/register_monitoring_telemetry_collection.ts#L34) | - | +| | [types.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/types.d.ts#L2) | - | +| | [types.d.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/types.d.ts#L61) | - | +| | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/index.d.ts#L1) | - | +| | [index.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/index.d.ts#L5) | - | +| | [register_monitoring_telemetry_collection.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/register_monitoring_telemetry_collection.d.ts#L1) | - | +| | [register_monitoring_telemetry_collection.d.ts#L3](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/register_monitoring_telemetry_collection.d.ts#L3) | - | +| | [get_usage_collector.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/get_usage_collector.d.ts#L2) | - | +| | [get_usage_collector.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/get_usage_collector.d.ts#L5) | - | +| | [types.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/types.ts#L13) | - | +| | [types.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/types.ts#L74) | - | +| | [instantiate_client.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/es_client/instantiate_client.ts#L9) | - | +| | [instantiate_client.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/es_client/instantiate_client.ts#L29) | - | +| | [license_service.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/license_service.ts#L9) | - | +| | [license_service.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/license_service.ts#L18) | - | +| | [static_globals.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/static_globals.ts#L8) | - | +| | [static_globals.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/static_globals.ts#L18) | - | +| | [static_globals.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/static_globals.ts#L43) | - | +| | [plugin.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/plugin.ts#L18) | - | +| | [plugin.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/plugin.ts#L74) | - | +| | [plugin.ts#L279](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/plugin.ts#L279) | - | +| | [types.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/types.d.ts#L2) | - | +| | [types.d.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/types.d.ts#L47) | - | +| | [plugin.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/plugin.d.ts#L1) | - | +| | [plugin.d.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/plugin.d.ts#L29) | - | +| | [license_service.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/license_service.d.ts#L1) | - | +| | [license_service.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/license_service.d.ts#L8) | - | +| | [static_globals.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/static_globals.d.ts#L1) | - | +| | [static_globals.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/static_globals.d.ts#L8) | - | +| | [static_globals.d.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/static_globals.d.ts#L15) | - | +| | [instantiate_client.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/es_client/instantiate_client.d.ts#L2) | - | +| | [instantiate_client.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/es_client/instantiate_client.d.ts#L5) | - | +| | [fetch_es_usage.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_es_usage.ts#L8) | - | +| | [fetch_es_usage.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_es_usage.ts#L45) | - | +| | [fetch_stack_product_usage.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_stack_product_usage.ts#L9) | - | +| | [fetch_stack_product_usage.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_stack_product_usage.ts#L36) | - | +| | [get_stack_products_usage.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/get_stack_products_usage.ts#L8) | - | +| | [get_stack_products_usage.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/get_stack_products_usage.ts#L27) | - | +| | [fetch_license_type.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_license_type.ts#L9) | - | +| | [fetch_license_type.ts#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/collectors/lib/fetch_license_type.ts#L14) | - | +| | [get_high_level_stats.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_high_level_stats.ts#L10) | - | +| | [get_high_level_stats.ts#L251](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_high_level_stats.ts#L251) | - | +| | [get_high_level_stats.ts#L272](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_high_level_stats.ts#L272) | - | +| | [get_logstash_stats.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_logstash_stats.ts#L9) | - | +| | [get_logstash_stats.ts#L264](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_logstash_stats.ts#L264) | - | +| | [get_logstash_stats.ts#L328](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_logstash_stats.ts#L328) | - | +| | [get_logstash_stats.ts#L395](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_logstash_stats.ts#L395) | - | +| | [get_beats_stats.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_beats_stats.ts#L10) | - | +| | [get_beats_stats.ts#L322](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_beats_stats.ts#L322) | - | +| | [get_beats_stats.ts#L386](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_beats_stats.ts#L386) | - | +| | [get_beats_stats.ts#L396](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_beats_stats.ts#L396) | - | +| | [get_beats_stats.ts#L414](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_beats_stats.ts#L414) | - | +| | [get_es_stats.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_es_stats.ts#L9) | - | +| | [get_es_stats.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_es_stats.ts#L20) | - | +| | [get_es_stats.ts#L38](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_es_stats.ts#L38) | - | +| | [get_kibana_stats.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_kibana_stats.ts#L11) | - | +| | [get_kibana_stats.ts#L186](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_kibana_stats.ts#L186) | - | +| | [get_all_stats.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_all_stats.ts#L12) | - | +| | [get_all_stats.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_all_stats.ts#L31) | - | +| | [get_cluster_uuids.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_cluster_uuids.ts#L10) | - | +| | [get_cluster_uuids.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_cluster_uuids.ts#L21) | - | +| | [get_cluster_uuids.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_cluster_uuids.ts#L33) | - | +| | [get_licenses.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_licenses.ts#L9) | - | +| | [get_licenses.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_licenses.ts#L18) | - | +| | [get_licenses.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/telemetry_collection/get_licenses.ts#L35) | - | +| | [disable_watcher_cluster_alerts.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/lib/alerts/disable_watcher_cluster_alerts.ts#L9) | - | +| | [disable_watcher_cluster_alerts.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/lib/alerts/disable_watcher_cluster_alerts.ts#L25) | - | +| | [disable_watcher_cluster_alerts.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/lib/alerts/disable_watcher_cluster_alerts.ts#L36) | - | +| | [get_es_stats.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_es_stats.d.ts#L2) | - | +| | [get_es_stats.d.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_es_stats.d.ts#L10) | - | +| | [get_es_stats.d.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_es_stats.d.ts#L20) | - | +| | [get_high_level_stats.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_high_level_stats.d.ts#L2) | - | +| | [get_high_level_stats.d.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_high_level_stats.d.ts#L78) | - | +| | [get_high_level_stats.d.ts#L83](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_high_level_stats.d.ts#L83) | - | +| | [get_kibana_stats.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_kibana_stats.d.ts#L2) | - | +| | [get_kibana_stats.d.ts#L82](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_kibana_stats.d.ts#L82) | - | +| | [get_beats_stats.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_beats_stats.d.ts#L2) | - | +| | [get_beats_stats.d.ts#L120](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_beats_stats.d.ts#L120) | - | +| | [get_beats_stats.d.ts#L123](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_beats_stats.d.ts#L123) | - | +| | [get_beats_stats.d.ts#L129](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_beats_stats.d.ts#L129) | - | +| | [get_logstash_stats.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_logstash_stats.d.ts#L2) | - | +| | [get_logstash_stats.d.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_logstash_stats.d.ts#L100) | - | +| | [get_logstash_stats.d.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_logstash_stats.d.ts#L103) | - | +| | [get_logstash_stats.d.ts#L109](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_logstash_stats.d.ts#L109) | - | +| | [get_all_stats.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_all_stats.d.ts#L1) | - | +| | [get_all_stats.d.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_all_stats.d.ts#L11) | - | +| | [get_cluster_uuids.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_cluster_uuids.d.ts#L1) | - | +| | [get_cluster_uuids.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_cluster_uuids.d.ts#L5) | - | +| | [get_cluster_uuids.d.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_cluster_uuids.d.ts#L10) | - | +| | [get_licenses.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_licenses.d.ts#L2) | - | +| | [get_licenses.d.ts#L7](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_licenses.d.ts#L7) | - | +| | [get_licenses.d.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_licenses.d.ts#L20) | - | +| | [disable_watcher_cluster_alerts.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/lib/alerts/disable_watcher_cluster_alerts.d.ts#L2) | - | +| | [disable_watcher_cluster_alerts.d.ts#L3](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/lib/alerts/disable_watcher_cluster_alerts.d.ts#L3) | - | +| | [fetch_es_usage.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_es_usage.d.ts#L1) | - | +| | [fetch_es_usage.d.ts#L4](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_es_usage.d.ts#L4) | - | +| | [fetch_license_type.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_license_type.d.ts#L1) | - | +| | [fetch_license_type.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_license_type.d.ts#L2) | - | +| | [fetch_stack_product_usage.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_stack_product_usage.d.ts#L1) | - | +| | [fetch_stack_product_usage.d.ts#L4](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/fetch_stack_product_usage.d.ts#L4) | - | +| | [get_stack_products_usage.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/get_stack_products_usage.d.ts#L1) | - | +| | [get_stack_products_usage.d.ts#L4](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/kibana_monitoring/collectors/lib/get_stack_products_usage.d.ts#L4) | - | + + + +## presentationUtil + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [saved_object_save_modal_dashboard.tsx#L13](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#L13) | - | +| | [saved_object_save_modal_dashboard.tsx#L103](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#L103) | - | + + + +## rollup + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [plugin.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/rollup/server/plugin.ts#L12) | - | +| | [plugin.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/rollup/server/plugin.ts#L36) | - | + + + +## savedObjectsManagement + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [service_registry.ts#L10](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/services/service_registry.ts#L10) | - | +| | [service_registry.ts#L14](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/services/service_registry.ts#L14) | - | +| | [resolve_saved_objects.ts#L12](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts#L12) | - | +| | [resolve_saved_objects.ts#L24](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts#L24) | - | +| | [resolve_saved_objects.ts#L239](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts#L239) | - | +| | [resolve_saved_objects.ts#L260](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts#L260) | - | +| | [create_field_list.ts#L13](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/create_field_list.ts#L13) | - | +| | [create_field_list.ts#L20](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/create_field_list.ts#L20) | - | +| | [form.tsx#L23](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/management_section/object_view/components/form.tsx#L23) | - | +| | [form.tsx#L31](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/management_section/object_view/components/form.tsx#L31) | - | +| | [resolve_saved_objects.ts#L12](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts#L12) | - | +| | [resolve_saved_objects.ts#L125](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts#L125) | - | +| | [resolve_saved_objects.ts#L223](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts#L223) | - | +| | [resolve_saved_objects.ts#L233](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/resolve_saved_objects.ts#L233) | - | + + + +## savedObjectsTaggingOss + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [api.ts#L14](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#L14) | - | +| | [types.ts#L9](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#L9) | - | +| | [types.ts#L14](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#L14) | - | +| | [api.ts#L14](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#L14) | - | +| | [api.ts#L75](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#L75) | - | + + + +## security + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [index.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/saved_objects/index.ts#L8) | - | +| | [index.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/saved_objects/index.ts#L34) | - | + + + +## securitySolution + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [shared_imports.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L10) | - | +| | [helpers.tsx#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L25) | - | +| | [helpers.tsx#L176](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L176) | - | +| | [shared_imports.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L11) | - | +| | [shared_imports.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L12) | - | +| | [helpers.tsx#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L26) | - | +| | [helpers.tsx#L332](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L332) | - | +| | [helpers.tsx#L360](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L360) | - | +| | [add_exception_comments.tsx#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_comments.tsx#L20) | - | +| | [add_exception_comments.tsx#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_comments.tsx#L26) | - | +| | [shared_imports.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L13) | - | +| | [helpers.tsx#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L27) | - | +| | [helpers.tsx#L332](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L332) | - | +| | [helpers.tsx#L360](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L360) | - | +| | [shared_imports.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L19) | - | +| | [types.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L15) | - | +| | [types.ts#L103](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L103) | - | +| | [helpers.tsx#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L28) | - | +| | [helpers.tsx#L307](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L307) | - | +| | [helpers.tsx#L650](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L650) | - | +| | [lists.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#L13) | - | +| | [lists.ts#L239](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#L239) | - | +| | [shared_imports.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L20) | - | +| | [types.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L19) | - | +| | [types.ts#L98](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L98) | - | +| | [types.ts#L115](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L115) | - | +| | [shared_imports.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L21) | - | +| | [types.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L16) | - | +| | [types.ts#L95](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L95) | - | +| | [types.ts#L112](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L112) | - | +| | [mapping.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/mapping.ts#L13) | - | +| | [mapping.ts#L104](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/mapping.ts#L104) | - | +| | [mapping.ts#L184](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/mapping.ts#L184) | - | +| | [shared_imports.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L22) | - | +| | [types.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L17) | - | +| | [types.ts#L97](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L97) | - | +| | [types.ts#L114](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L114) | - | +| | [shared_imports.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L23) | - | +| | [types.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L18) | - | +| | [types.ts#L96](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L96) | - | +| | [types.ts#L113](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L113) | - | +| | [mapping.ts#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/mapping.ts#L14) | - | +| | [mapping.ts#L188](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/mapping.ts#L188) | - | +| | [shared_imports.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L24) | - | +| | [types.ts#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L14) | - | +| | [types.ts#L109](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L109) | - | +| | [helpers.tsx#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L40) | - | +| | [helpers.tsx#L307](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L307) | - | +| | [helpers.test.tsx#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L46) | - | +| | [helpers.test.tsx#L425](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L425) | - | +| | [helpers.test.tsx#L444](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L444) | - | +| | [helpers.test.tsx#L471](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L471) | - | +| | [mapping.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/mapping.ts#L15) | - | +| | [mapping.ts#L192](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/mapping.ts#L192) | - | +| | [lists.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#L13) | - | +| | [lists.ts#L239](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#L239) | - | +| | [shared_imports.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L25) | - | +| | [create_field_and_set_tuples.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.ts#L8) | - | +| | [create_field_and_set_tuples.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.ts#L19) | - | +| | [create_field_and_set_tuples.test.ts#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.test.ts#L14) | - | +| | [create_field_and_set_tuples.test.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.test.ts#L78) | - | +| | [create_field_and_set_tuples.test.ts#L90](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.test.ts#L90) | - | +| | [create_field_and_set_tuples.test.ts#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.test.ts#L102) | - | +| | [create_field_and_set_tuples.test.ts#L115](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.test.ts#L115) | - | +| | [create_field_and_set_tuples.test.ts#L131](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.test.ts#L131) | - | +| | [create_field_and_set_tuples.test.ts#L144](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.test.ts#L144) | - | +| | [lists.test.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#L12) | - | +| | [lists.test.ts#L329](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#L329) | - | +| | [shared_imports.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L26) | - | +| | [utils.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/detection_engine/utils.ts#L12) | - | +| | [utils.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/detection_engine/utils.ts#L23) | - | +| | [utils.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/detection_engine/utils.ts#L28) | - | +| | [utils.test.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/detection_engine/utils.test.ts#L16) | - | +| | [utils.test.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/detection_engine/utils.test.ts#L26) | - | +| | [utils.test.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/detection_engine/utils.test.ts#L46) | - | +| | [utils.test.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/detection_engine/utils.test.ts#L74) | - | +| | [utils.test.ts#L95](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/detection_engine/utils.test.ts#L95) | - | +| | [helpers.tsx#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L42) | - | +| | [helpers.tsx#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L87) | - | +| | [helpers.tsx#L87](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L87) | - | +| | [mapping.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/mapping.ts#L12) | - | +| | [mapping.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/mapping.ts#L80) | - | +| | [mapping.ts#L204](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/mapping.ts#L204) | - | +| | [helpers.test.tsx#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L62) | - | +| | [helpers.test.tsx#L661](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L661) | - | +| | [helpers.test.tsx#L702](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L702) | - | +| | [helpers.test.tsx#L783](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L783) | - | +| | [helpers.test.tsx#L787](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L787) | - | +| | [helpers.test.tsx#L793](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L793) | - | +| | [helpers.test.tsx#L800](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L800) | - | +| | [helpers.test.tsx#L804](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L804) | - | +| | [helpers.test.tsx#L810](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L810) | - | +| | [index.test.tsx#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_modal/index.test.tsx#L24) | - | +| | [index.test.tsx#L426](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_modal/index.test.tsx#L426) | - | +| | [index.test.tsx#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/edit_exception_modal/index.test.tsx#L23) | - | +| | [index.test.tsx#L133](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/edit_exception_modal/index.test.tsx#L133) | - | +| | [lists.test.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#L12) | - | +| | [lists.test.ts#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#L73) | - | +| | [lists.test.ts#L119](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#L119) | - | +| | [lists.test.ts#L170](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#L170) | - | +| | [lists.test.ts#L223](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#L223) | - | +| | [lists.test.ts#L275](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#L275) | - | +| | [lists.test.ts#L319](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.test.ts#L319) | - | +| | [shared_imports.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L28) | - | +| | [shared_imports.ts#L29](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L29) | - | +| | [types.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/types.ts#L10) | - | +| | [types.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/types.ts#L21) | - | +| | [types.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L24) | - | +| | [types.ts#L77](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L77) | - | +| | [types.ts#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L85) | - | +| | [operators.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L10) | - | +| | [operators.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L18) | - | +| | [operators.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L27) | - | +| | [operators.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L36) | - | +| | [operators.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L45) | - | +| | [operators.ts#L54](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L54) | - | +| | [operators.ts#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L63) | - | +| | [operators.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L72) | - | +| | [operators.ts#L81](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L81) | - | +| | [helpers.test.tsx#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L46) | - | +| | [helpers.test.tsx#L347](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L347) | - | +| | [helpers.test.tsx#L366](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L366) | - | +| | [helpers.test.tsx#L387](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L387) | - | +| | [helpers.test.tsx#L408](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L408) | - | +| | [shared_imports.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L30) | - | +| | [types.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/types.ts#L10) | - | +| | [types.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/types.ts#L22) | - | +| | [types.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L23) | - | +| | [types.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L78) | - | +| | [types.ts#L78](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L78) | - | +| | [types.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L86) | - | +| | [types.ts#L93](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/types.ts#L93) | - | +| | [operators.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L10) | - | +| | [operators.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L17) | - | +| | [operators.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L26) | - | +| | [operators.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L35) | - | +| | [operators.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L44) | - | +| | [operators.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L53) | - | +| | [operators.ts#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L62) | - | +| | [operators.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L71) | - | +| | [operators.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/operators.ts#L80) | - | +| | [use_field_value_autocomplete.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.ts#L13) | - | +| | [use_field_value_autocomplete.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.ts#L28) | - | +| | [use_field_value_autocomplete.ts#L101](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.ts#L101) | - | +| | [field_value_match.tsx#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/field_value_match.tsx#L21) | - | +| | [field_value_match.tsx#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/field_value_match.tsx#L59) | - | +| | [field_value_match_any.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/field_value_match_any.tsx#L15) | - | +| | [field_value_match_any.tsx#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/field_value_match_any.tsx#L51) | - | +| | [use_field_value_autocomplete.test.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.test.ts#L18) | - | +| | [use_field_value_autocomplete.test.ts#L51](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.test.ts#L51) | - | +| | [use_field_value_autocomplete.test.ts#L71](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.test.ts#L71) | - | +| | [use_field_value_autocomplete.test.ts#L94](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.test.ts#L94) | - | +| | [use_field_value_autocomplete.test.ts#L117](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.test.ts#L117) | - | +| | [use_field_value_autocomplete.test.ts#L152](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.test.ts#L152) | - | +| | [use_field_value_autocomplete.test.ts#L192](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.test.ts#L192) | - | +| | [use_field_value_autocomplete.test.ts#L228](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.test.ts#L228) | - | +| | [use_field_value_autocomplete.test.ts#L254](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.test.ts#L254) | - | +| | [use_field_value_autocomplete.test.ts#L289](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.test.ts#L289) | - | +| | [helpers.tsx#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L31) | - | +| | [helpers.tsx#L105](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L105) | - | +| | [helpers.tsx#L108](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L108) | - | +| | [helpers.tsx#L110](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L110) | - | +| | [helpers.tsx#L112](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L112) | - | +| | [helpers.tsx#L114](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L114) | - | +| | [helpers.tsx#L144](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L144) | - | +| | [helpers.tsx#L145](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L145) | - | +| | [helpers.tsx#L147](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L147) | - | +| | [helpers.tsx#L149](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L149) | - | +| | [helpers.tsx#L445](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L445) | - | +| | [helpers.test.tsx#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L46) | - | +| | [helpers.test.tsx#L171](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L171) | - | +| | [helpers.test.tsx#L178](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L178) | - | +| | [helpers.test.tsx#L185](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L185) | - | +| | [helpers.test.tsx#L192](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L192) | - | +| | [helpers.test.tsx#L346](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L346) | - | +| | [helpers.test.tsx#L365](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L365) | - | +| | [helpers.test.tsx#L386](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L386) | - | +| | [helpers.test.tsx#L407](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L407) | - | +| | [helpers.test.tsx#L427](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L427) | - | +| | [helpers.test.tsx#L446](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L446) | - | +| | [helpers.test.tsx#L473](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L473) | - | +| | [helpers.test.tsx#L661](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L661) | - | +| | [shared_imports.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L31) | - | +| | [exceptions_viewer_header.tsx#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.tsx#L23) | - | +| | [exceptions_viewer_header.tsx#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.tsx#L27) | - | +| | [exceptions_viewer_header.tsx#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.tsx#L31) | - | +| | [exceptions_viewer_header.tsx#L94](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.tsx#L94) | - | +| | [exceptions_viewer_header.tsx#L108](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.tsx#L108) | - | +| | [exceptions_viewer_header.tsx#L113](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.tsx#L113) | - | +| | [index.tsx#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.tsx#L23) | - | +| | [index.tsx#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.tsx#L59) | - | +| | [index.tsx#L231](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.tsx#L231) | - | +| | [exceptions_viewer_header.stories.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.stories.tsx#L15) | - | +| | [exceptions_viewer_header.stories.tsx#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.stories.tsx#L28) | - | +| | [exceptions_viewer_header.stories.tsx#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.stories.tsx#L28) | - | +| | [exceptions_viewer_header.stories.tsx#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.stories.tsx#L40) | - | +| | [exceptions_viewer_header.stories.tsx#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.stories.tsx#L40) | - | +| | [exceptions_viewer_header.stories.tsx#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.stories.tsx#L52) | - | +| | [exceptions_viewer_header.stories.tsx#L64](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.stories.tsx#L64) | - | +| | [exceptions_viewer_header.test.tsx#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L12) | - | +| | [exceptions_viewer_header.test.tsx#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L18) | - | +| | [exceptions_viewer_header.test.tsx#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L18) | - | +| | [exceptions_viewer_header.test.tsx#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L47) | - | +| | [exceptions_viewer_header.test.tsx#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L47) | - | +| | [exceptions_viewer_header.test.tsx#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L65) | - | +| | [exceptions_viewer_header.test.tsx#L83](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L83) | - | +| | [exceptions_viewer_header.test.tsx#L101](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L101) | - | +| | [exceptions_viewer_header.test.tsx#L101](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L101) | - | +| | [exceptions_viewer_header.test.tsx#L141](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L141) | - | +| | [exceptions_viewer_header.test.tsx#L141](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L141) | - | +| | [exceptions_viewer_header.test.tsx#L181](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L181) | - | +| | [exceptions_viewer_header.test.tsx#L199](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L199) | - | +| | [exceptions_viewer_header.test.tsx#L217](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L217) | - | +| | [exceptions_viewer_header.test.tsx#L217](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L217) | - | +| | [exceptions_viewer_header.test.tsx#L238](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L238) | - | +| | [exceptions_viewer_header.test.tsx#L238](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L238) | - | +| | [exceptions_viewer_header.test.tsx#L259](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L259) | - | +| | [exceptions_viewer_header.test.tsx#L259](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_viewer_header.test.tsx#L259) | - | +| | [index.test.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.test.tsx#L15) | - | +| | [index.test.tsx#L95](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.test.tsx#L95) | - | +| | [index.test.tsx#L112](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.test.tsx#L112) | - | +| | [index.test.tsx#L148](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.test.tsx#L148) | - | +| | [index.tsx#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx#L85) | - | +| | [index.tsx#L462](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx#L462) | - | +| | [index.tsx#L467](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx#L467) | - | +| | [index.tsx#L472](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx#L472) | - | +| | [index.tsx#L473](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx#L473) | - | +| | [index.tsx#L477](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx#L477) | - | +| | [index.tsx#L481](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx#L481) | - | +| | [index.tsx#L484](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx#L484) | - | +| | [constants.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#L10) | - | +| | [constants.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#L18) | - | +| | [shared_imports.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L34) | - | +| | [helpers.tsx#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L33) | - | +| | [helpers.tsx#L363](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L363) | - | +| | [shared_imports.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L33) | - | +| | [lists.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/detection_engine/schemas/types/lists.ts#L10) | - | +| | [lists.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/detection_engine/schemas/types/lists.ts#L21) | - | +| | [shared_imports.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L37) | - | +| | [helpers.tsx#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L34) | - | +| | [helpers.tsx#L252](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L252) | - | +| | [shared_imports.ts#L38](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L38) | - | +| | [helpers.tsx#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/helpers.tsx#L10) | - | +| | [helpers.tsx#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/helpers.tsx#L44) | - | +| | [helpers.tsx#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L35) | - | +| | [helpers.tsx#L232](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L232) | - | +| | [helpers.tsx#L244](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L244) | - | +| | [shared_imports.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L40) | - | +| | [shared_imports.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L41) | - | +| | [shared_imports.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L42) | - | +| | [shared_imports.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L43) | - | +| | [shared_imports.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L44) | - | +| | [create_field_and_set_tuples.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.ts#L8) | - | +| | [create_field_and_set_tuples.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/create_field_and_set_tuples.ts#L20) | - | +| | [filter_events_against_list.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events_against_list.ts#L8) | - | +| | [filter_events_against_list.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events_against_list.ts#L55) | - | +| | [shared_imports.ts#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L46) | - | +| | [reducer.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/reducer.ts#L15) | - | +| | [reducer.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/reducer.ts#L31) | - | +| | [reducer.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/reducer.ts#L57) | - | +| | [use_fetch_or_create_rule_exception_list.test.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/use_fetch_or_create_rule_exception_list.test.tsx#L15) | - | +| | [use_fetch_or_create_rule_exception_list.test.tsx#L46](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/use_fetch_or_create_rule_exception_list.test.tsx#L46) | - | +| | [use_fetch_or_create_rule_exception_list.test.tsx#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/use_fetch_or_create_rule_exception_list.test.tsx#L47) | - | +| | [helpers.tsx#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L44) | - | +| | [helpers.tsx#L59](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L59) | - | +| | [index.tsx#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_modal/index.tsx#L37) | - | +| | [index.tsx#L70](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_modal/index.tsx#L70) | - | +| | [helpers.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/create/helpers.ts#L16) | - | +| | [helpers.ts#L319](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/create/helpers.ts#L319) | - | +| | [index.tsx#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/edit_exception_modal/index.tsx#L36) | - | +| | [index.tsx#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/edit_exception_modal/index.tsx#L63) | - | +| | [constants.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#L9) | - | +| | [constants.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/event_filters/constants.ts#L18) | - | +| | [alert_context_menu.tsx#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/alerts_table/timeline_actions/alert_context_menu.tsx#L47) | - | +| | [alert_context_menu.tsx#L113](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/alerts_table/timeline_actions/alert_context_menu.tsx#L113) | - | +| | [shared_imports.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L55) | - | +| | [helpers.tsx#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L43) | - | +| | [helpers.tsx#L404](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L404) | - | +| | [shared_imports.ts#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L56) | - | +| | [shared_imports.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/shared_imports.ts#L57) | - | +| | [helpers.tsx#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L41) | - | +| | [helpers.tsx#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L60) | - | +| | [helpers.tsx#L389](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L389) | - | +| | [helpers.tsx#L399](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L399) | - | +| | [helpers.tsx#L400](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx#L400) | - | +| | [index.tsx#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_modal/index.tsx#L65) | - | +| | [index.tsx#L305](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_modal/index.tsx#L305) | - | +| | [index.tsx#L56](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/edit_exception_modal/index.tsx#L56) | - | +| | [index.tsx#L285](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/edit_exception_modal/index.tsx#L285) | - | +| | [helpers.test.tsx#L63](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L63) | - | +| | [helpers.test.tsx#L596](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L596) | - | +| | [helpers.test.tsx#L609](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx#L609) | - | +| | [index.tsx#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#L14) | - | +| | [index.tsx#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#L30) | - | +| | [index.tsx#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#L27) | - | +| | [index.tsx#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#L44) | - | +| | [routes.tsx#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#L13) | - | +| | [routes.tsx#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#L23) | - | +| | [app.tsx#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/app.tsx#L14) | - | +| | [app.tsx#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/app.tsx#L33) | - | +| | [app.tsx#L73](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/app.tsx#L73) | - | +| | [metadata.test.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts#L9) | - | +| | [metadata.test.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts#L57) | - | +| | [metadata.test.ts#L80](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts#L80) | - | +| | [metadata_v1.test.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts#L9) | - | +| | [metadata_v1.test.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts#L52) | - | +| | [metadata_v1.test.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts#L74) | - | +| | [service.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/policy/service.ts#L11) | - | +| | [service.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/policy/service.ts#L52) | - | +| | [mocks.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/mocks.ts#L8) | - | +| | [mocks.ts#L135](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/mocks.ts#L135) | - | +| | [metadata.test.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts#L10) | - | +| | [metadata.test.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata.test.ts#L58) | - | +| | [metadata_v1.test.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts#L10) | - | +| | [metadata_v1.test.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/metadata/metadata_v1.test.ts#L53) | - | +| | [handlers.test.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/policy/handlers.test.ts#L16) | - | +| | [handlers.test.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/policy/handlers.test.ts#L36) | - | +| | [sender.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/telemetry/sender.ts#L10) | - | +| | [sender.ts#L447](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/telemetry/sender.ts#L447) | - | +| | [sender.ts#L466](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/telemetry/sender.ts#L466) | - | +| | [types.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/types.ts#L53) | - | +| | [types.ts#L110](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/types.ts#L110) | - | + + + +## visualizations + +| Deprecated API | Reference location | Remove By | +| ---------------|-----------|-----------| +| | [find_list_items.ts#L16](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/find_list_items.ts#L16) | - | +| | [find_list_items.ts#L35](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/find_list_items.ts#L35) | - | +| | [saved_visualizations.ts#L10](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualizations.ts#L10) | - | +| | [saved_visualizations.ts#L28](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualizations.ts#L28) | - | +| | [saved_visualizations.ts#L85](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualizations.ts#L85) | - | +| | [services.ts#L26](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/services.ts#L26) | - | +| | [services.ts#L72](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/services.ts#L72) | - | +| | [types.ts#L9](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/types.ts#L9) | - | +| | [types.ts#L41](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/types.ts#L41) | - | +| | [_saved_vis.ts#L16](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#L16) | - | +| | [_saved_vis.ts#L105](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#L105) | - | +| | [_saved_vis.ts#L114](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#L114) | - | +| | [_saved_vis.ts#L124](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#L124) | - | \ No newline at end of file diff --git a/api_docs/dev_tools.json b/api_docs/dev_tools.json index a2215041f27cd..5f9212c1bfca9 100644 --- a/api_docs/dev_tools.json +++ b/api_docs/dev_tools.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "devTools", "id": "def-public.DevToolsPlugin", "type": "Class", "tags": [], @@ -34,11 +35,19 @@ }, ", void, object, object>" ], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "devTools", "id": "def-public.DevToolsPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(coreSetup: ", { @@ -54,13 +63,19 @@ "DevToolApp", "; }" ], - "description": [], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { + "parentPluginId": "devTools", "id": "def-public.DevToolsPlugin.setup.$1", "type": "Object", + "tags": [], "label": "coreSetup", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -71,84 +86,84 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/dev_tools/public/plugin.ts", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "devTools", "id": "def-public.DevToolsPlugin.setup.$2.urlForwarding", "type": "Object", - "label": "{ urlForwarding }", "tags": [], + "label": "{ urlForwarding }", "description": [], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "devTools", "id": "def-public.DevToolsPlugin.setup.$2.urlForwarding.urlForwarding", "type": "Object", + "tags": [], "label": "urlForwarding", "description": [], + "signature": [ + "{ forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }" + ], "source": { "path": "src/plugins/dev_tools/public/plugin.ts", "lineNumber": 43 }, - "signature": [ - "{ forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/dev_tools/public/plugin.ts", - "lineNumber": 43 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/dev_tools/public/plugin.ts", - "lineNumber": 43 - } + "returnComment": [] }, { + "parentPluginId": "devTools", "id": "def-public.DevToolsPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/dev_tools/public/plugin.ts", "lineNumber": 84 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "devTools", "id": "def-public.DevToolsPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/dev_tools/public/plugin.ts", - "lineNumber": 90 - } + "lineNumber": 104 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/dev_tools/public/plugin.ts", - "lineNumber": 35 - }, "initialIsOpen": false } ], @@ -158,36 +173,40 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "devTools", "id": "def-public.DevToolsSetup", "type": "Interface", + "tags": [], "label": "DevToolsSetup", "description": [], - "tags": [], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "devTools", "id": "def-public.DevToolsSetup.register", "type": "Function", + "tags": [], "label": "register", "description": [ "\nRegister a developer tool. It will be available\nin the dev tools app under a separate tab.\n\nRegistering dev tools works almost similar to registering\napplications in the core application service,\nbut they will be rendered with a frame containing tabs\nto switch between the tools." ], - "source": { - "path": "src/plugins/dev_tools/public/plugin.ts", - "lineNumber": 32 - }, "signature": [ "(devTool: ", "CreateDevToolArgs", ") => ", "DevToolApp" - ] + ], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/dev_tools/public/plugin.ts", - "lineNumber": 21 - }, "lifecycle": "setup", "initialIsOpen": true } diff --git a/api_docs/discover.json b/api_docs/discover.json index 246382a449fc3..fd4ff8cafca6d 100644 --- a/api_docs/discover.json +++ b/api_docs/discover.json @@ -4,9 +4,12 @@ "classes": [], "functions": [ { + "parentPluginId": "discover", "id": "def-public.createSavedSearchesLoader", "type": "Function", + "tags": [], "label": "createSavedSearchesLoader", + "description": [], "signature": [ "({ savedObjectsClient, savedObjects }: Services) => ", { @@ -17,103 +20,114 @@ "text": "SavedObjectLoader" } ], - "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/saved_searches.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "discover", "id": "def-public.createSavedSearchesLoader.$1", "type": "Object", + "tags": [], "label": "{ savedObjectsClient, savedObjects }", - "isRequired": true, + "description": [], "signature": [ "Services" ], - "description": [], "source": { "path": "src/plugins/discover/public/saved_searches/saved_searches.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/discover/public/saved_searches/saved_searches.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "discover", "id": "def-public.loadSharingDataHelpers", "type": "Function", + "tags": [], "label": "loadSharingDataHelpers", + "description": [], "signature": [ "() => Promise" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/discover/public/shared/index.ts", "lineNumber": 12 }, + "deprecated": false, + "children": [], + "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState", "type": "Interface", + "tags": [], "label": "DiscoverUrlGeneratorState", "description": [], - "tags": [], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.savedSearchId", "type": "string", + "tags": [], "label": "savedSearchId", "description": [ "\nOptionally set saved search ID." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/discover/public/url_generator.ts", "lineNumber": 26 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.indexPatternId", "type": "string", + "tags": [], "label": "indexPatternId", "description": [ "\nOptionally set index pattern ID." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/discover/public/url_generator.ts", "lineNumber": 31 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.timeRange", "type": "Object", + "tags": [], "label": "timeRange", "description": [ "\nOptionally set the time range in the time picker." ], - "source": { - "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 36 - }, "signature": [ { "pluginId": "data", @@ -123,20 +137,22 @@ "text": "TimeRange" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 36 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.refreshInterval", "type": "Object", + "tags": [], "label": "refreshInterval", "description": [ "\nOptionally set the refresh interval." ], - "source": { - "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 41 - }, "signature": [ { "pluginId": "data", @@ -146,20 +162,22 @@ "text": "RefreshInterval" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 41 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.filters", "type": "Array", + "tags": [], "label": "filters", "description": [ "\nOptionally apply filters." ], - "source": { - "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 46 - }, "signature": [ { "pluginId": "data", @@ -169,20 +187,22 @@ "text": "Filter" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 46 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.query", "type": "Object", + "tags": [], "label": "query", "description": [ "\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query." ], - "source": { - "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 52 - }, "signature": [ { "pluginId": "data", @@ -192,115 +212,131 @@ "text": "Query" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 52 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.useHash", "type": "CompoundType", + "tags": [], "label": "useHash", "description": [ "\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/discover/public/url_generator.ts", "lineNumber": 58 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.searchSessionId", "type": "string", + "tags": [], "label": "searchSessionId", "description": [ "\nBackground search session id" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/discover/public/url_generator.ts", "lineNumber": 63 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.columns", "type": "Array", + "tags": [], "label": "columns", "description": [ "\nColumns displayed in the table" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/discover/public/url_generator.ts", "lineNumber": 68 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.interval", "type": "string", + "tags": [], "label": "interval", "description": [ "\nUsed interval of the histogram" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/discover/public/url_generator.ts", "lineNumber": 73 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.sort", "type": "Array", + "tags": [], "label": "sort", "description": [ "\nArray of the used sorting [[field,direction],...]" ], + "signature": [ + "string[][] | undefined" + ], "source": { "path": "src/plugins/discover/public/url_generator.ts", "lineNumber": 77 }, - "signature": [ - "string[][] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.savedQuery", "type": "string", + "tags": [], "label": "savedQuery", "description": [ "\nid of the used saved query" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/discover/public/url_generator.ts", "lineNumber": 81 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "discover", "id": "def-public.ISearchEmbeddable", "type": "Interface", + "tags": [], "label": "ISearchEmbeddable", + "description": [], "signature": [ { "pluginId": "discover", @@ -329,13 +365,19 @@ "SearchOutput", ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "discover", "id": "def-public.ISearchEmbeddable.getSavedSearch", "type": "Function", + "tags": [], "label": "getSavedSearch", + "description": [], "signature": [ "() => ", { @@ -346,61 +388,63 @@ "text": "SavedSearch" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/discover/public/application/embeddable/types.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/discover/public/application/embeddable/types.ts", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "discover", "id": "def-public.SavedSearch", "type": "Interface", + "tags": [], "label": "SavedSearch", "description": [], - "tags": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.searchSource", "type": "Object", + "tags": [], "label": "searchSource", "description": [], - "source": { - "path": "src/plugins/discover/public/saved_searches/types.ts", - "lineNumber": 17 - }, "signature": [ { "pluginId": "data", @@ -409,89 +453,101 @@ "section": "def-common.SearchSource", "text": "SearchSource" } - ] + ], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.description", "type": "string", + "tags": [], "label": "description", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.columns", "type": "Array", + "tags": [], "label": "columns", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 19 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.sort", "type": "Array", + "tags": [], "label": "sort", "description": [], + "signature": [ + "SortOrder", + "[]" + ], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 20 }, - "signature": [ - "SortOrder", - "[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.grid", "type": "Object", + "tags": [], "label": "grid", "description": [], + "signature": [ + "DiscoverGridSettings" + ], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 21 }, - "signature": [ - "DiscoverGridSettings" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.destroy", "type": "Function", + "tags": [], "label": "destroy", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 22 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.save", "type": "Function", + "tags": [], "label": "save", "description": [], - "source": { - "path": "src/plugins/discover/public/saved_searches/types.ts", - "lineNumber": 23 - }, "signature": [ "(saveOptions: ", { @@ -502,74 +558,84 @@ "text": "SavedObjectSaveOpts" }, ") => Promise" - ] + ], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 23 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.lastSavedTitle", "type": "string", + "tags": [], "label": "lastSavedTitle", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 24 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.copyOnSave", "type": "CompoundType", + "tags": [], "label": "copyOnSave", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 25 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearch.hideChart", "type": "CompoundType", + "tags": [], "label": "hideChart", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 26 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/discover/public/saved_searches/types.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "discover", "id": "def-public.SavedSearchLoader", "type": "Interface", + "tags": [], "label": "SavedSearchLoader", "description": [], - "tags": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearchLoader.get", "type": "Function", + "tags": [], "label": "get", "description": [], - "source": { - "path": "src/plugins/discover/public/saved_searches/types.ts", - "lineNumber": 29 - }, "signature": [ "(id: string) => Promise<", { @@ -580,33 +646,39 @@ "text": "SavedSearch" }, ">" - ] + ], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SavedSearchLoader.urlFor", "type": "Function", + "tags": [], "label": "urlFor", "description": [], + "signature": [ + "(id: string) => string" + ], "source": { "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 30 }, - "signature": [ - "(id: string) => string" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/discover/public/saved_searches/types.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "discover", "id": "def-public.SearchInput", "type": "Interface", + "tags": [], "label": "SearchInput", + "description": [], "signature": [ { "pluginId": "discover", @@ -624,19 +696,19 @@ "text": "EmbeddableInput" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SearchInput.timeRange", "type": "Object", + "tags": [], "label": "timeRange", "description": [], - "source": { - "path": "src/plugins/discover/public/application/embeddable/types.ts", - "lineNumber": 20 - }, "signature": [ { "pluginId": "data", @@ -645,18 +717,20 @@ "section": "def-common.TimeRange", "text": "TimeRange" } - ] + ], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 20 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SearchInput.query", "type": "Object", + "tags": [], "label": "query", "description": [], - "source": { - "path": "src/plugins/discover/public/application/embeddable/types.ts", - "lineNumber": 21 - }, "signature": [ { "pluginId": "data", @@ -666,18 +740,20 @@ "text": "Query" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SearchInput.filters", "type": "Array", + "tags": [], "label": "filters", "description": [], - "source": { - "path": "src/plugins/discover/public/application/embeddable/types.ts", - "lineNumber": 22 - }, "signature": [ { "pluginId": "data", @@ -687,145 +763,161 @@ "text": "Filter" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 22 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SearchInput.hidePanelTitles", "type": "CompoundType", + "tags": [], "label": "hidePanelTitles", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/discover/public/application/embeddable/types.ts", "lineNumber": 23 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SearchInput.columns", "type": "Array", + "tags": [], "label": "columns", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/discover/public/application/embeddable/types.ts", "lineNumber": 24 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SearchInput.sort", "type": "Array", + "tags": [], "label": "sort", "description": [], + "signature": [ + "SortOrder", + "[] | undefined" + ], "source": { "path": "src/plugins/discover/public/application/embeddable/types.ts", "lineNumber": 25 }, - "signature": [ - "SortOrder", - "[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/discover/public/application/embeddable/types.ts", - "lineNumber": 19 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DISCOVER_APP_URL_GENERATOR", "type": "string", + "tags": [], "label": "DISCOVER_APP_URL_GENERATOR", "description": [], + "signature": [ + "\"DISCOVER_APP_URL_GENERATOR\"" + ], "source": { "path": "src/plugins/discover/public/url_generator.ts", "lineNumber": 20 }, - "signature": [ - "\"DISCOVER_APP_URL_GENERATOR\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.SEARCH_EMBEDDABLE_TYPE", "type": "string", + "tags": [], "label": "SEARCH_EMBEDDABLE_TYPE", "description": [], + "signature": [ + "\"search\"" + ], "source": { "path": "src/plugins/discover/public/application/embeddable/constants.ts", "lineNumber": 9 }, - "signature": [ - "\"search\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "discover", "id": "def-public.DiscoverSetup", "type": "Interface", + "tags": [], "label": "DiscoverSetup", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/discover/public/plugin.tsx", + "lineNumber": 76 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverSetup.docViews", "type": "Object", + "tags": [], "label": "docViews", "description": [], - "source": { - "path": "src/plugins/discover/public/plugin.tsx", - "lineNumber": 76 - }, "signature": [ - "{ addDocView(docViewRaw: ", - "DocViewInput", - " | ", + "{ addDocView(docViewRaw: ComponentDocViewInput | ", + "RenderDocViewInput", + " | DirectiveDocViewInput | ", "DocViewInputFn", "): void; }" - ] + ], + "source": { + "path": "src/plugins/discover/public/plugin.tsx", + "lineNumber": 77 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/discover/public/plugin.tsx", - "lineNumber": 75 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "discover", "id": "def-public.DiscoverStart", "type": "Interface", + "tags": [], "label": "DiscoverStart", "description": [], - "tags": [], + "source": { + "path": "src/plugins/discover/public/plugin.tsx", + "lineNumber": 87 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverStart.savedSearchLoader", "type": "Object", + "tags": [], "label": "savedSearchLoader", "description": [], - "source": { - "path": "src/plugins/discover/public/plugin.tsx", - "lineNumber": 87 - }, "signature": [ { "pluginId": "savedObjects", @@ -834,20 +926,22 @@ "section": "def-public.SavedObjectLoader", "text": "SavedObjectLoader" } - ] + ], + "source": { + "path": "src/plugins/discover/public/plugin.tsx", + "lineNumber": 88 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-public.DiscoverStart.urlGenerator", "type": "Object", + "tags": [], "label": "urlGenerator", "description": [ "\n`share` plugin URL generator for Discover app. Use it to generate links into\nDiscover application, example:\n\n```ts\nconst url = await plugins.discover.urlGenerator.createUrl({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```" ], - "source": { - "path": "src/plugins/discover/public/plugin.tsx", - "lineNumber": 105 - }, "signature": [ { "pluginId": "share", @@ -857,13 +951,14 @@ "text": "UrlGeneratorContract" }, "<\"DISCOVER_APP_URL_GENERATOR\"> | undefined" - ] + ], + "source": { + "path": "src/plugins/discover/public/plugin.tsx", + "lineNumber": 106 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/discover/public/plugin.tsx", - "lineNumber": 86 - }, "lifecycle": "start", "initialIsOpen": true } @@ -883,183 +978,224 @@ "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "discover", "id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING", "type": "string", + "tags": [], "label": "CONTEXT_DEFAULT_SIZE_SETTING", "description": [], + "signature": [ + "\"context:defaultSize\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 15 }, - "signature": [ - "\"context:defaultSize\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.CONTEXT_STEP_SETTING", "type": "string", + "tags": [], "label": "CONTEXT_STEP_SETTING", "description": [], + "signature": [ + "\"context:step\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 16 }, - "signature": [ - "\"context:step\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.CONTEXT_TIE_BREAKER_FIELDS_SETTING", "type": "string", + "tags": [], "label": "CONTEXT_TIE_BREAKER_FIELDS_SETTING", "description": [], + "signature": [ + "\"context:tieBreakerFields\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 17 }, - "signature": [ - "\"context:tieBreakerFields\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.DEFAULT_COLUMNS_SETTING", "type": "string", + "tags": [], "label": "DEFAULT_COLUMNS_SETTING", "description": [], + "signature": [ + "\"defaultColumns\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 9 }, - "signature": [ - "\"defaultColumns\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.DOC_HIDE_TIME_COLUMN_SETTING", "type": "string", + "tags": [], "label": "DOC_HIDE_TIME_COLUMN_SETTING", "description": [], + "signature": [ + "\"doc_table:hideTimeColumn\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 13 }, - "signature": [ - "\"doc_table:hideTimeColumn\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.DOC_TABLE_LEGACY", "type": "string", + "tags": [], "label": "DOC_TABLE_LEGACY", "description": [], + "signature": [ + "\"doc_table:legacy\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 18 }, - "signature": [ - "\"doc_table:legacy\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.FIELDS_LIMIT_SETTING", "type": "string", + "tags": [], "label": "FIELDS_LIMIT_SETTING", "description": [], + "signature": [ + "\"fields:popularLimit\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 14 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "discover", + "id": "def-common.MAX_DOC_FIELDS_DISPLAYED", + "type": "string", + "tags": [], + "label": "MAX_DOC_FIELDS_DISPLAYED", + "description": [], "signature": [ - "\"fields:popularLimit\"" + "\"discover:maxDocFieldsDisplayed\"" ], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.MODIFY_COLUMNS_ON_SWITCH", "type": "string", + "tags": [], "label": "MODIFY_COLUMNS_ON_SWITCH", "description": [], + "signature": [ + "\"discover:modifyColumnsOnSwitch\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 19 }, - "signature": [ - "\"discover:modifyColumnsOnSwitch\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.SAMPLE_SIZE_SETTING", "type": "string", + "tags": [], "label": "SAMPLE_SIZE_SETTING", "description": [], + "signature": [ + "\"discover:sampleSize\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 10 }, - "signature": [ - "\"discover:sampleSize\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.SEARCH_FIELDS_FROM_SOURCE", "type": "string", + "tags": [], "label": "SEARCH_FIELDS_FROM_SOURCE", "description": [], + "signature": [ + "\"discover:searchFieldsFromSource\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 20 }, - "signature": [ - "\"discover:searchFieldsFromSource\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.SEARCH_ON_PAGE_LOAD_SETTING", "type": "string", + "tags": [], "label": "SEARCH_ON_PAGE_LOAD_SETTING", "description": [], + "signature": [ + "\"discover:searchOnPageLoad\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 12 }, - "signature": [ - "\"discover:searchOnPageLoad\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.SORT_DEFAULT_ORDER_SETTING", "type": "string", + "tags": [], "label": "SORT_DEFAULT_ORDER_SETTING", "description": [], + "signature": [ + "\"discover:sort:defaultOrder\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 11 }, - "signature": [ - "\"discover:sort:defaultOrder\"" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/discover_enhanced.json b/api_docs/discover_enhanced.json index 6ff98fb2b2efa..7c7d8b78607eb 100644 --- a/api_docs/discover_enhanced.json +++ b/api_docs/discover_enhanced.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin", "type": "Class", "tags": [], @@ -42,17 +43,19 @@ }, ">" ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin.config", "type": "Object", + "tags": [], "label": "config", "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 43 - }, "signature": [ { "pluginId": "discoverEnhanced", @@ -61,22 +64,36 @@ "section": "def-common.Config", "text": "Config" } - ] + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 43 + }, + "deprecated": false }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -87,24 +104,23 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -132,13 +148,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -157,17 +179,20 @@ }, ", unknown>" ], - "description": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", "lineNumber": 50 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin.setup.$2", "type": "Object", + "tags": [], "label": "{ uiActions, share }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "discoverEnhanced", @@ -177,24 +202,23 @@ "text": "DiscoverEnhancedSetupDependencies" } ], - "description": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", "lineNumber": 51 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 49 - } + "returnComment": [] }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -214,13 +238,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -230,17 +260,20 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 69 - } + "lineNumber": 71 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin.start.$2", "type": "Object", + "tags": [], "label": "plugins", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "discoverEnhanced", @@ -250,44 +283,39 @@ "text": "DiscoverEnhancedStartDependencies" } ], - "description": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 69 - } + "lineNumber": 71 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 69 - } + "returnComment": [] }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 71 - } + "lineNumber": 73 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 40 - }, "initialIsOpen": false }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataChartAction", "type": "Class", "tags": [], @@ -318,101 +346,105 @@ "<", "ExploreDataChartActionContext" ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataChartAction.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "\"ACTION_EXPLORE_DATA_CHART\"" + ], "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", "lineNumber": 35 }, - "signature": [ - "\"ACTION_EXPLORE_DATA_CHART\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataChartAction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"ACTION_EXPLORE_DATA_CHART\"" + ], "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", "lineNumber": 37 }, - "signature": [ - "\"ACTION_EXPLORE_DATA_CHART\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataChartAction.order", "type": "number", + "tags": [], "label": "order", "description": [], + "signature": [ + "200" + ], "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", "lineNumber": 39 }, - "signature": [ - "200" - ] + "deprecated": false }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataChartAction.isCompatible", "type": "Function", + "tags": [], "label": "isCompatible", + "description": [], "signature": [ "(context: ", "ExploreDataChartActionContext", ") => Promise" ], - "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataChartAction.isCompatible.$1", "type": "Object", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ "ExploreDataChartActionContext" ], - "description": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", - "lineNumber": 41 - } + "returnComment": [] }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataChartAction.getUrl", "type": "Function", - "children": [ - { - "id": "def-public.ExploreDataChartAction.getUrl.$1", - "type": "Object", - "label": "context", - "isRequired": true, - "signature": [ - "ExploreDataChartActionContext" - ], - "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", - "lineNumber": 47 - } - } - ], + "tags": [], + "label": "getUrl", + "description": [], "signature": [ "(context: ", "ExploreDataChartActionContext", @@ -426,23 +458,37 @@ }, ">" ], - "description": [], - "label": "getUrl", "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", "lineNumber": 46 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "discoverEnhanced", + "id": "def-public.ExploreDataChartAction.getUrl.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "ExploreDataChartActionContext" + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 47 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", - "lineNumber": 32 - }, "initialIsOpen": false }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataContextMenuAction", "type": "Class", "tags": [], @@ -470,68 +516,67 @@ }, "" ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataContextMenuAction.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "\"ACTION_EXPLORE_DATA\"" + ], "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", "lineNumber": 37 }, - "signature": [ - "\"ACTION_EXPLORE_DATA\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataContextMenuAction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"ACTION_EXPLORE_DATA\"" + ], "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", "lineNumber": 39 }, - "signature": [ - "\"ACTION_EXPLORE_DATA\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataContextMenuAction.order", "type": "number", + "tags": [], "label": "order", "description": [], + "signature": [ + "200" + ], "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", "lineNumber": 41 }, - "signature": [ - "200" - ] + "deprecated": false }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.ExploreDataContextMenuAction.getUrl", "type": "Function", - "children": [ - { - "id": "def-public.ExploreDataContextMenuAction.getUrl.$1", - "type": "Object", - "label": "context", - "isRequired": true, - "signature": [ - "EmbeddableQueryContext" - ], - "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", - "lineNumber": 43 - } - } - ], + "tags": [], + "label": "getUrl", + "description": [], "signature": [ "(context: EmbeddableQueryContext) => Promise<", { @@ -543,42 +588,58 @@ }, ">" ], - "description": [], - "label": "getUrl", "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", "lineNumber": 43 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "discoverEnhanced", + "id": "def-public.ExploreDataContextMenuAction.getUrl.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "EmbeddableQueryContext" + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", + "lineNumber": 43 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", - "lineNumber": 34 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedSetupDependencies", "type": "Interface", + "tags": [], "label": "DiscoverEnhancedSetupDependencies", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedSetupDependencies.discover", "type": "Object", + "tags": [], "label": "discover", "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 25 - }, "signature": [ { "pluginId": "discover", @@ -587,18 +648,20 @@ "section": "def-public.DiscoverSetup", "text": "DiscoverSetup" } - ] + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 25 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedSetupDependencies.embeddable", "type": "Object", + "tags": [], "label": "embeddable", "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 26 - }, "signature": [ { "pluginId": "embeddable", @@ -607,32 +670,36 @@ "section": "def-public.EmbeddableSetup", "text": "EmbeddableSetup" } - ] + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 26 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedSetupDependencies.kibanaLegacy", "type": "Object", + "tags": [], "label": "kibanaLegacy", "description": [], + "signature": [ + "{} | undefined" + ], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", "lineNumber": 27 }, - "signature": [ - "{} | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedSetupDependencies.share", "type": "CompoundType", + "tags": [], "label": "share", "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 28 - }, "signature": [ { "pluginId": "share", @@ -642,18 +709,20 @@ "text": "SharePluginSetup" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 28 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedSetupDependencies.uiActions", "type": "Object", + "tags": [], "label": "uiActions", "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 29 - }, "signature": [ "Pick<", { @@ -664,32 +733,36 @@ "text": "UiActionsService" }, ", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">" - ] + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 29 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedStartDependencies", "type": "Interface", + "tags": [], "label": "DiscoverEnhancedStartDependencies", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedStartDependencies.discover", "type": "Object", + "tags": [], "label": "discover", "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 33 - }, "signature": [ { "pluginId": "discover", @@ -698,18 +771,20 @@ "section": "def-public.DiscoverStart", "text": "DiscoverStart" } - ] + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedStartDependencies.embeddable", "type": "Object", + "tags": [], "label": "embeddable", "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 34 - }, "signature": [ { "pluginId": "embeddable", @@ -718,34 +793,38 @@ "section": "def-public.EmbeddableStart", "text": "EmbeddableStart" } - ] + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 34 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedStartDependencies.kibanaLegacy", "type": "Object", + "tags": [], "label": "kibanaLegacy", "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 35 - }, "signature": [ "{ dashboardConfig: ", "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 35 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedStartDependencies.share", "type": "CompoundType", + "tags": [], "label": "share", "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 36 - }, "signature": [ { "pluginId": "share", @@ -755,18 +834,20 @@ "text": "SharePluginStart" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 36 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-public.DiscoverEnhancedStartDependencies.uiActions", "type": "Object", + "tags": [], "label": "uiActions", "description": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 37 - }, "signature": [ "Pick<", { @@ -787,13 +868,14 @@ "text": "UiActionsService" }, ">>" - ] + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 37 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 32 - }, "initialIsOpen": false } ], @@ -814,31 +896,35 @@ "functions": [], "interfaces": [ { + "parentPluginId": "discoverEnhanced", "id": "def-common.Config", "type": "Interface", + "tags": [], "label": "Config", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/common/config.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "discoverEnhanced", "id": "def-common.Config.actions", "type": "Object", + "tags": [], "label": "actions", "description": [], + "signature": [ + "{ exploreDataInChart: { enabled: boolean; }; exploreDataInContextMenu: { enabled: boolean; }; }" + ], "source": { "path": "x-pack/plugins/discover_enhanced/common/config.ts", "lineNumber": 9 }, - "signature": [ - "{ exploreDataInChart: { enabled: boolean; }; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/discover_enhanced/common/config.ts", - "lineNumber": 8 - }, "initialIsOpen": false } ], diff --git a/api_docs/embeddable.json b/api_docs/embeddable.json index c1b8313259aee..26e576e1fde4a 100644 --- a/api_docs/embeddable.json +++ b/api_docs/embeddable.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction", "type": "Class", "tags": [], @@ -26,49 +27,67 @@ }, "" ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"ACTION_ADD_PANEL\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 24 }, - "signature": [ - "\"ACTION_ADD_PANEL\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "\"ACTION_ADD_PANEL\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 25 }, - "signature": [ - "\"ACTION_ADD_PANEL\"" - ] + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.Unnamed.$1", "type": "Function", + "tags": [], "label": "getFactory", - "isRequired": true, + "description": [], "signature": [ " IterableIterator<", { @@ -164,17 +186,20 @@ "text": "EmbeddableInput" } ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.Unnamed.$3", "type": "Object", + "tags": [], "label": "overlays", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -184,17 +209,20 @@ "text": "OverlayStart" } ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.Unnamed.$4", "type": "Object", + "tags": [], "label": "notifications", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -204,70 +232,76 @@ "text": "NotificationsStart" } ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.Unnamed.$5", "type": "CompoundType", + "tags": [], "label": "SavedObjectFinder", - "isRequired": true, + "description": [], "signature": [ "React.ComponentType" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "lineNumber": 27 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.getDisplayName", "type": "Function", + "tags": [], "label": "getDisplayName", + "description": [], "signature": [ "() => string" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.getIconType", "type": "Function", + "tags": [], "label": "getIconType", + "description": [], "signature": [ "() => string" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.isCompatible", "type": "Function", + "tags": [], "label": "isCompatible", + "description": [], "signature": [ "(context: ", { @@ -279,13 +313,19 @@ }, ") => Promise" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.isCompatible.$1", "type": "CompoundType", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "uiActions", @@ -296,24 +336,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.execute", "type": "Function", + "tags": [], "label": "execute", + "description": [], "signature": [ "(context: ", { @@ -325,13 +364,19 @@ }, ") => Promise" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AddPanelAction.execute.$1", "type": "CompoundType", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "uiActions", @@ -342,28 +387,21 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 50 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "lineNumber": 50 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService", "type": "Class", "tags": [], @@ -379,63 +417,86 @@ }, "" ], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.Unnamed.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.Unnamed.$2", "type": "Function", + "tags": [], "label": "showSaveModal", - "isRequired": true, + "description": [], "signature": [ "(saveModal: React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>, I18nContext: ({ children }: { children: React.ReactNode; }) => JSX.Element) => void" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 50 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.Unnamed.$3", "type": "Function", + "tags": [], "label": "i18nContext", - "isRequired": true, + "description": [], "signature": [ "({ children }: { children: React.ReactNode; }) => JSX.Element" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 54 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.Unnamed.$4", "type": "Object", + "tags": [], "label": "toasts", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -447,32 +508,38 @@ }, ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.Unnamed.$5", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ "AttributeServiceOptions", "" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 56 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.Unnamed.$6", "type": "Function", + "tags": [], "label": "getEmbeddableFactory", - "isRequired": false, + "description": [], "signature": [ "((embeddableFactoryId: string) => ", { @@ -515,145 +582,165 @@ "text": "EmbeddableInput" } ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "lineNumber": 48 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.unwrapAttributes", "type": "Function", + "tags": [], "label": "unwrapAttributes", + "description": [], "signature": [ "(input: ValType | RefType) => Promise" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.unwrapAttributes.$1", "type": "CompoundType", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "ValType | RefType" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 74 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "lineNumber": 74 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.wrapAttributes", "type": "Function", + "tags": [], "label": "wrapAttributes", + "description": [], "signature": [ "(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise>>" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.wrapAttributes.$1", "type": "Uncategorized", + "tags": [], "label": "newAttributes", - "isRequired": true, + "description": [], "signature": [ "SavedObjectAttributes" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 84 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.wrapAttributes.$2", "type": "boolean", + "tags": [], "label": "useRefType", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 85 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.wrapAttributes.$3", "type": "CompoundType", + "tags": [], "label": "input", - "isRequired": false, + "description": [], "signature": [ "ValType | RefType | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "lineNumber": 83 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.inputIsRefType", "type": "Function", + "tags": [], + "label": "inputIsRefType", + "description": [], + "signature": [ + "(input: ValType | RefType) => input is RefType" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 116 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.inputIsRefType.$1", "type": "CompoundType", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "ValType | RefType" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 116 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(input: ValType | RefType) => input is RefType" - ], - "description": [], - "label": "inputIsRefType", - "source": { - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "lineNumber": 116 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.getExplicitInputFromEmbeddable", "type": "Function", + "tags": [], "label": "getExplicitInputFromEmbeddable", + "description": [], "signature": [ "(embeddable: ", { @@ -681,13 +768,19 @@ }, ">) => ValType | RefType" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 120 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.getExplicitInputFromEmbeddable.$1", "type": "Object", + "tags": [], "label": "embeddable", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -714,104 +807,110 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 120 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "lineNumber": 120 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.getInputAsValueType", "type": "Function", + "tags": [], + "label": "getInputAsValueType", + "description": [], + "signature": [ + "(input: ValType | RefType) => Promise" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 125 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.getInputAsValueType.$1", "type": "CompoundType", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "ValType | RefType" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 125 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.getInputAsRefType", + "type": "Function", + "tags": [], + "label": "getInputAsRefType", + "description": [], "signature": [ - "(input: ValType | RefType) => Promise" + "(input: ValType | RefType, saveOptions?: { showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined) => Promise" ], - "description": [], - "label": "getInputAsValueType", "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "lineNumber": 125 + "lineNumber": 137 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.AttributeService.getInputAsRefType", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.getInputAsRefType.$1", "type": "CompoundType", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "ValType | RefType" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.AttributeService.getInputAsRefType.$2", "type": "CompoundType", + "tags": [], "label": "saveOptions", - "isRequired": false, + "description": [], "signature": [ "{ showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 139 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(input: ValType | RefType, saveOptions?: { showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined) => Promise" - ], - "description": [], - "label": "getInputAsRefType", - "source": { - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "lineNumber": 137 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "lineNumber": 41 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.Container", "type": "Class", "tags": [], @@ -843,72 +942,96 @@ }, "" ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Container.isContainer", "type": "boolean", + "tags": [], "label": "isContainer", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 34 - } + }, + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.Container.children", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "children", + "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "children": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Container.Unnamed.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "TContainerInput" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.Container.Unnamed.$2", "type": "Uncategorized", + "tags": [], "label": "output", - "isRequired": true, + "description": [], "signature": [ "TContainerOutput" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.Container.Unnamed.$3", "type": "Function", + "tags": [], "label": "getFactory", - "isRequired": true, + "description": [], "signature": [ " | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 41 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.updateInputForChild", "type": "Function", + "tags": [], "label": "updateInputForChild", + "description": [], "signature": [ "(id: string, changes: Partial) => void" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Container.updateInputForChild.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.Container.updateInputForChild.$2", "type": "Object", + "tags": [], "label": "changes", - "isRequired": true, + "description": [], "signature": [ "Partial" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 58 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 56 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.reload", "type": "Function", + "tags": [], "label": "reload", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 78 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.addNewEmbeddable", "type": "Function", + "tags": [], "label": "addNewEmbeddable", + "description": [], "signature": [ "" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 82 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.removeEmbeddable", "type": "Function", + "tags": [], "label": "removeEmbeddable", + "description": [], "signature": [ "(embeddableId: string) => void" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Container.removeEmbeddable.$1", "type": "string", + "tags": [], "label": "embeddableId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 98 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 98 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.getChildIds", "type": "Function", + "tags": [], "label": "getChildIds", + "description": [], "signature": [ "() => string[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 106 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.getChild", "type": "Function", + "tags": [], "label": "getChild", + "description": [], "signature": [ ">(id: string) => E" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 110 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Container.getChild.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 110 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 110 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.getInputForChild", "type": "Function", + "tags": [], "label": "getInputForChild", + "description": [], "signature": [ "(embeddableId: string) => TEmbeddableInput" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 114 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Container.getInputForChild.$1", "type": "string", + "tags": [], "label": "embeddableId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 115 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 114 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.destroy", "type": "Function", + "tags": [], "label": "destroy", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 146 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.untilEmbeddableLoaded", "type": "Function", + "tags": [], "label": "untilEmbeddableLoaded", + "description": [], "signature": [ "" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 152 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Container.untilEmbeddableLoaded.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 153 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 152 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.createNewPanelState", "type": "Function", + "tags": [], "label": "createNewPanelState", + "description": [], "signature": [ "" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 184 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.Container.createNewPanelState.$2", "type": "Object", + "tags": [], "label": "partial", - "isRequired": true, + "description": [], "signature": [ "Partial" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 185 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 180 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.getPanelState", "type": "Function", + "tags": [], "label": "getPanelState", + "description": [], "signature": [ "" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 204 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Container.getPanelState.$1", "type": "string", + "tags": [], "label": "embeddableId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 205 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 204 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Container.getInheritedInput", "type": "Function", + "tags": [], "label": "getInheritedInput", - "signature": [ - "(id: string) => TChildInput" - ], "description": [ "\nReturn state that comes from the container and is passed down to the child. For instance, time range and\nfilters are common inherited input state. Note that any state stored in `this.input.panels[embeddableId].explicitInput`\nwill override inherited input." ], - "children": [ - { + "signature": [ + "(id: string) => TChildInput" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 219 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", "id": "def-public.Container.getInheritedInput.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 219 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 219 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction", "type": "Class", "tags": [], @@ -1597,74 +1776,96 @@ }, "" ], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"editPanel\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 38 }, - "signature": [ - "\"editPanel\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "\"editPanel\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 39 }, - "signature": [ - "\"editPanel\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.order", "type": "number", + "tags": [], "label": "order", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 40 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.currentAppId", "type": "string", + "tags": [], "label": "currentAppId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 41 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.Unnamed.$1", "type": "Function", + "tags": [], "label": "getEmbeddableFactory", - "isRequired": true, + "description": [], "signature": [ " string" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.getDisplayName.$1", "type": "Object", + "tags": [], "label": "{ embeddable }", - "isRequired": true, + "description": [], "signature": [ "ActionContext" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "lineNumber": 55 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.getIconType", "type": "Function", + "tags": [], "label": "getIconType", + "description": [], "signature": [ "() => string" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 68 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.isCompatible", "type": "Function", + "tags": [], "label": "isCompatible", + "description": [], "signature": [ "({ embeddable }: ActionContext) => Promise" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 72 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.isCompatible.$1", "type": "Object", + "tags": [], "label": "{ embeddable }", - "isRequired": true, + "description": [], "signature": [ "ActionContext" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 72 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "lineNumber": 72 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.execute", "type": "Function", + "tags": [], "label": "execute", + "description": [], "signature": [ "(context: ActionContext) => Promise" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.execute.$1", "type": "Object", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ "ActionContext" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "lineNumber": 83 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.getAppTarget", "type": "Function", + "tags": [], "label": "getAppTarget", + "description": [], "signature": [ "({ embeddable }: ActionContext) => NavigationContext | undefined" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.getAppTarget.$1", "type": "Object", + "tags": [], "label": "{ embeddable }", - "isRequired": true, + "description": [], "signature": [ "ActionContext" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 104 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "lineNumber": 104 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.getHref", "type": "Function", + "tags": [], "label": "getHref", + "description": [], "signature": [ "({ embeddable }: ActionContext) => Promise" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 121 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EditPanelAction.getHref.$1", "type": "Object", + "tags": [], "label": "{ embeddable }", - "isRequired": true, + "description": [], "signature": [ "ActionContext" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 121 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "lineNumber": 121 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "lineNumber": 37 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable", "type": "Class", "tags": [], @@ -1964,39 +2191,45 @@ }, "" ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Embeddable.runtimeId", "type": "number", + "tags": [], "label": "runtimeId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 27 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Embeddable.runtimeId", "type": "number", + "tags": [], "label": "runtimeId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 29 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Embeddable.parent", "type": "Object", + "tags": [], "label": "parent", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 31 - }, "signature": [ { "pluginId": "embeddable", @@ -2022,93 +2255,107 @@ "text": "ContainerOutput" }, "> | undefined" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 31 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Embeddable.isContainer", "type": "boolean", + "tags": [], "label": "isContainer", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 32 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Embeddable.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Embeddable.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 34 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Embeddable.fatalError", "type": "Object", + "tags": [], "label": "fatalError", "description": [], + "signature": [ + "Error | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 35 }, - "signature": [ - "Error | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Embeddable.output", "type": "Uncategorized", + "tags": [], "label": "output", "description": [], + "signature": [ + "TEmbeddableOutput" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 37 }, - "signature": [ - "TEmbeddableOutput" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Embeddable.input", "type": "Uncategorized", + "tags": [], "label": "input", "description": [], + "signature": [ + "TEmbeddableInput" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 38 }, - "signature": [ - "TEmbeddableInput" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Embeddable.renderComplete", "type": "Object", + "tags": [], "label": "renderComplete", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 43 - }, "signature": [ { "pluginId": "kibanaUtils", @@ -2117,50 +2364,70 @@ "section": "def-public.RenderCompleteDispatcher", "text": "RenderCompleteDispatcher" } - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 43 + }, + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], - "children": [ - { - "id": "def-public.Embeddable.Unnamed.$1", + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 51 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.Unnamed.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "TEmbeddableInput" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 51 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.Unnamed.$2", "type": "Uncategorized", + "tags": [], "label": "output", - "isRequired": true, + "description": [], "signature": [ "TEmbeddableOutput" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 51 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.Unnamed.$3", "type": "Object", + "tags": [], "label": "parent", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -2187,24 +2454,23 @@ }, "> | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 51 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 51 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.getIsContainer", "type": "Function", + "tags": [], "label": "getIsContainer", + "description": [], "signature": [ "() => this is ", { @@ -2232,141 +2498,159 @@ }, ">" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 89 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.reload", "type": "Function", + "tags": [], "label": "reload", - "signature": [ - "() => void" - ], "description": [ "\nReload will be called when there is a request to refresh the data or view, even if the\ninput data did not change.\n\nIn case if input data did change and reload is requested input$ and output$ would still emit before `reload` is called\n\nThe order would be as follows:\ninput$\noutput$\nreload()\n----\nupdated$" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 106 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.getUpdated$", "type": "Function", + "tags": [], "label": "getUpdated$", + "description": [ + "\nMerges input$ and output$ streams and debounces emit till next macro-task.\nCould be useful to batch reactions to input$ and output$ updates that happen separately but synchronously.\nIn case corresponding state change triggered `reload` this stream is guarantied to emit later,\nwhich allows to skip any state handling in case `reload` already handled it." + ], "signature": [ "() => Readonly<", "Observable", ">" ], - "description": [ - "\nMerges input$ and output$ streams and debounces emit till next macro-task.\nCould be useful to batch reactions to input$ and output$ updates that happen separately but synchronously.\nIn case corresponding state change triggered `reload` this stream is guarantied to emit later,\nwhich allows to skip any state handling in case `reload` already handled it." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 114 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.getInput$", "type": "Function", + "tags": [], "label": "getInput$", + "description": [], "signature": [ "() => Readonly<", "Observable", ">" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 120 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.getOutput$", "type": "Function", + "tags": [], "label": "getOutput$", + "description": [], "signature": [ "() => Readonly<", "Observable", ">" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 124 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.getOutput", "type": "Function", + "tags": [], "label": "getOutput", + "description": [], "signature": [ "() => Readonly" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 128 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.getInput", "type": "Function", + "tags": [], "label": "getInput", + "description": [], "signature": [ "() => Readonly" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 132 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.getTitle", "type": "Function", + "tags": [], "label": "getTitle", + "description": [], "signature": [ "() => string" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 136 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.getRoot", "type": "Function", + "tags": [], "label": "getRoot", + "description": [ + "\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent." + ], "signature": [ "() => ", { @@ -2409,83 +2693,97 @@ "text": "ContainerInput" } ], - "description": [ - "\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 144 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.updateInput", "type": "Function", + "tags": [], "label": "updateInput", + "description": [], "signature": [ "(changes: Partial) => void" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 152 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.updateInput.$1", "type": "Object", + "tags": [], "label": "changes", - "isRequired": true, + "description": [], "signature": [ "Partial" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 152 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 152 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.render", "type": "Function", + "tags": [], "label": "render", + "description": [], "signature": [ "(el: HTMLElement) => void" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 164 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.render.$1", "type": "Object", + "tags": [], "label": "el", - "isRequired": true, + "description": [], "signature": [ "HTMLElement" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 164 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 164 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.getInspectorAdapters", "type": "Function", + "tags": [ + "return" + ], "label": "getInspectorAdapters", + "description": [ + "\nAn embeddable can return inspector adapters if it want the inspector to be\navailable via the context menu of that panel." + ], "signature": [ "() => ", { @@ -2497,125 +2795,131 @@ }, " | undefined" ], - "description": [ - "\nAn embeddable can return inspector adapters if it want the inspector to be\navailable via the context menu of that panel." - ], - "children": [], - "tags": [ - "return" - ], - "returnComment": [ - "Inspector adapters that will be used to open an inspector for." - ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 179 - } + }, + "deprecated": false, + "children": [], + "returnComment": [ + "Inspector adapters that will be used to open an inspector for." + ] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.destroy", "type": "Function", + "tags": [], "label": "destroy", - "signature": [ - "() => void" - ], "description": [ "\nCalled when this embeddable is no longer used, this should be the place for\nimplementors to add any additional clean up tasks, like unmounting and unsubscribing." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 187 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.updateOutput", "type": "Function", + "tags": [], "label": "updateOutput", + "description": [], "signature": [ "(outputChanges: Partial) => void" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 199 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.updateOutput.$1", "type": "Object", + "tags": [], "label": "outputChanges", - "isRequired": true, + "description": [], "signature": [ "Partial" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 199 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 199 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.onFatalError", "type": "Function", + "tags": [], "label": "onFatalError", + "description": [], "signature": [ "(e: Error) => void" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 210 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.onFatalError.$1", "type": "Object", + "tags": [], "label": "e", - "isRequired": true, + "description": [], "signature": [ "Error" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 210 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 210 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.Embeddable.supportedTriggers", "type": "Function", + "tags": [], "label": "supportedTriggers", + "description": [], "signature": [ "() => string[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 238 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanel", "type": "Class", "tags": [], @@ -2641,28 +2945,32 @@ }, ", State, any>" ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanel.mounted", "type": "boolean", + "tags": [], "label": "mounted", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 36 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanel.embeddable", "type": "CompoundType", + "tags": [], "label": "embeddable", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "lineNumber": 37 - }, "signature": [ { "pluginId": "embeddable", @@ -2695,22 +3003,36 @@ "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" } - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 37 + }, + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanel.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanel.Unnamed.$1", "type": "Object", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -2720,76 +3042,75 @@ "text": "EmbeddableChildPanelProps" } ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 40 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "lineNumber": 40 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanel.componentDidMount", "type": "Function", + "tags": [], "label": "componentDidMount", + "description": [], "signature": [ "() => Promise" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 49 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanel.componentWillUnmount", "type": "Function", + "tags": [], "label": "componentWillUnmount", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 59 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanel.render", "type": "Function", + "tags": [], "label": "render", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 66 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactoryNotFoundError", "type": "Class", "tags": [], @@ -2805,57 +3126,66 @@ }, " extends Error" ], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactoryNotFoundError.code", "type": "string", + "tags": [], "label": "code", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/errors.ts", - "lineNumber": 27 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/errors.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel", "type": "Class", "tags": [], @@ -2871,188 +3201,215 @@ }, " extends React.Component" ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 89 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 96 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.Unnamed.$1", "type": "Object", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 96 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", - "lineNumber": 96 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.UNSAFE_componentWillMount", "type": "Function", + "tags": [], "label": "UNSAFE_componentWillMount", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 153 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.componentWillUnmount", "type": "Function", + "tags": [], "label": "componentWillUnmount", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 187 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.onFocus", "type": "Function", + "tags": [], + "label": "onFocus", + "description": [], + "signature": [ + "(focusedPanelIndex: string) => void" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 199 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.onFocus.$1", "type": "string", + "tags": [], "label": "focusedPanelIndex", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 199 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(focusedPanelIndex: string) => void" - ], - "description": [], - "label": "onFocus", - "source": { - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", - "lineNumber": 199 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.onBlur", "type": "Function", + "tags": [], + "label": "onBlur", + "description": [], + "signature": [ + "(blurredPanelIndex: string) => void" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 203 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.onBlur.$1", "type": "string", + "tags": [], "label": "blurredPanelIndex", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 203 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(blurredPanelIndex: string) => void" - ], - "description": [], - "label": "onBlur", - "source": { - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", - "lineNumber": 203 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.render", "type": "Function", + "tags": [], "label": "render", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 209 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.componentDidMount", "type": "Function", + "tags": [], "label": "componentDidMount", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 251 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanel.closeMyContextMenuPanel", "type": "Function", - "children": [], + "tags": [], + "label": "closeMyContextMenuPanel", + "description": [], "signature": [ "() => void" ], - "description": [], - "label": "closeMyContextMenuPanel", "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 274 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", - "lineNumber": 89 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableRoot", "type": "Class", "tags": [], @@ -3068,175 +3425,210 @@ }, " extends React.Component" ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableRoot.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableRoot.Unnamed.$1", "type": "Object", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", - "lineNumber": 25 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableRoot.componentDidMount", "type": "Function", + "tags": [], "label": "componentDidMount", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 31 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableRoot.componentDidUpdate", "type": "Function", + "tags": [], "label": "componentDidUpdate", + "description": [], "signature": [ "(prevProps?: Props | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableRoot.componentDidUpdate.$1", "type": "Object", + "tags": [], "label": "prevProps", - "isRequired": false, + "description": [], "signature": [ "Props | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", - "lineNumber": 38 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableRoot.shouldComponentUpdate", "type": "Function", + "tags": [], "label": "shouldComponentUpdate", + "description": [], "signature": [ "(newProps: Props) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableRoot.shouldComponentUpdate.$1", "type": "Object", + "tags": [], "label": "newProps", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", - "lineNumber": 59 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableRoot.render", "type": "Function", + "tags": [], "label": "render", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 69 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "EmbeddableStateTransfer", "description": [ "\nA wrapper around the session storage which provides strongly typed helper methods\nfor common incoming and outgoing states used by the embeddable infrastructure.\n" ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.isTransferInProgress", "type": "boolean", + "tags": [], "label": "isTransferInProgress", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.Unnamed.$1", "type": "Function", + "tags": [], "label": "navigateToApp", - "isRequired": true, + "description": [], "signature": [ "(appId: string, options?: ", { @@ -3248,32 +3640,38 @@ }, " | undefined) => Promise" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.Unnamed.$2", "type": "Object", + "tags": [], "label": "currentAppId$", - "isRequired": true, + "description": [], "signature": [ "Observable", "" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.Unnamed.$3", "type": "Object", + "tags": [], "label": "appList", - "isRequired": false, + "description": [], "signature": [ "ReadonlyMap | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.Unnamed.$4", "type": "Object", + "tags": [], "label": "customStorage", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -3306,57 +3707,63 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 37 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 33 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getAppNameFromId", "type": "Function", + "tags": [], + "label": "getAppNameFromId", + "description": [ + "\nFetches an internationalized app title when given an appId." + ], + "signature": [ + "(appId: string) => string | undefined" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getAppNameFromId.$1", "type": "string", + "tags": [], "label": "appId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 50 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(appId: string) => string | undefined" - ], - "description": [ - "\nFetches an internationalized app title when given an appId." - ], - "label": "getAppNameFromId", - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 50 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEditorState", "type": "Function", + "tags": [], "label": "getIncomingEditorState", + "description": [ + "\nFetches an {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n" + ], "signature": [ "(appId: string, removeAfterFetch?: boolean | undefined) => ", { @@ -3368,89 +3775,102 @@ }, " | undefined" ], - "description": [ - "\nFetches an {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n" - ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 58 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEditorState.$1", "type": "string", + "tags": [], "label": "appId", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The app to fetch incomingEditorState for" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEditorState.$2", "type": "CompoundType", + "tags": [], "label": "removeAfterFetch", - "isRequired": false, - "signature": [ - "boolean | undefined" - ], "description": [ "- Whether to remove the package state after fetch to prevent duplicates." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 58 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.clearEditorState", "type": "Function", + "tags": [], "label": "clearEditorState", - "signature": [ - "(appId?: string | undefined) => void" - ], "description": [ "\nClears the {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n" ], + "signature": [ + "(appId?: string | undefined) => void" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 78 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.clearEditorState.$1", "type": "string", + "tags": [], "label": "appId", - "isRequired": false, - "signature": [ - "string | undefined" - ], "description": [ "- The app to fetch incomingEditorState for" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 78 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 78 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage", "type": "Function", + "tags": [], "label": "getIncomingEmbeddablePackage", + "description": [ + "\nFetches an {@link EmbeddablePackageState | embeddable package} from the sessionStorage for the given AppId\n" + ], "signature": [ "(appId: string, removeAfterFetch?: boolean | undefined) => ", { @@ -3462,56 +3882,64 @@ }, " | undefined" ], - "description": [ - "\nFetches an {@link EmbeddablePackageState | embeddable package} from the sessionStorage for the given AppId\n" - ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 96 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage.$1", "type": "string", + "tags": [], "label": "appId", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- The app to fetch EmbeddablePackageState for" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 97 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage.$2", "type": "CompoundType", + "tags": [], "label": "removeAfterFetch", - "isRequired": false, - "signature": [ - "boolean | undefined" - ], "description": [ "- Whether to remove the package state after fetch to prevent duplicates." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 98 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 96 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor", "type": "Function", + "tags": [], "label": "navigateToEditor", + "description": [ + "\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; state: ", + "(appId: string, options?: { path?: string | undefined; openInNewTab?: boolean | undefined; state: ", { "pluginId": "embeddable", "scope": "public", @@ -3521,55 +3949,81 @@ }, "; } | undefined) => Promise" ], - "description": [ - "\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddableEditorState | embeddable editor state}" - ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 114 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$1", "type": "string", + "tags": [], "label": "appId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 115 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 116 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.path", "type": "string", + "tags": [], "label": "path", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 117 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.openInNewTab", + "type": "CompoundType", "tags": [], - "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.state", - "type": "Object", - "label": "state", + "label": "openInNewTab", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 118 }, + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -3578,26 +4032,27 @@ "section": "def-public.EmbeddableEditorState", "text": "EmbeddableEditorState" } - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 119 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 116 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 114 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage", "type": "Function", + "tags": [], "label": "navigateToWithEmbeddablePackage", + "description": [ + "\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddablePackageState | embeddable package state}" + ], "signature": [ "(appId: string, options?: { path?: string | undefined; state: ", { @@ -3609,55 +4064,65 @@ }, "; } | undefined) => Promise" ], - "description": [ - "\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddablePackageState | embeddable package state}" - ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 132 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$1", "type": "string", + "tags": [], "label": "appId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 132 - } + "lineNumber": 133 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 134 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.options.path", "type": "string", + "tags": [], "label": "path", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 133 + "lineNumber": 134 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.options.state", "type": "Object", + "tags": [], "label": "state", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 133 - }, "signature": [ { "pluginId": "embeddable", @@ -3666,30 +4131,23 @@ "section": "def-public.EmbeddablePackageState", "text": "EmbeddablePackageState" } - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 134 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 133 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 131 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable", "type": "Class", "tags": [], @@ -3729,63 +4187,84 @@ }, ">" ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"error\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 26 }, - "signature": [ - "\"error\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable.error", "type": "CompoundType", + "tags": [], "label": "error", "description": [], + "signature": [ + "string | Error" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 27 }, - "signature": [ - "string | Error" - ] + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable.Unnamed.$1", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "string | Error" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable.Unnamed.$2", "type": "Object", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -3795,17 +4274,20 @@ "text": "EmbeddableInput" } ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable.Unnamed.$3", "type": "Object", + "tags": [], "label": "parent", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -3832,91 +4314,93 @@ }, "> | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", - "lineNumber": 30 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable.reload", "type": "Function", + "tags": [], "label": "reload", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 35 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable.render", "type": "Function", + "tags": [], "label": "render", + "description": [], "signature": [ "(dom: HTMLElement) => void" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable.render.$1", "type": "Object", + "tags": [], "label": "dom", - "isRequired": true, + "description": [], "signature": [ "HTMLElement" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 37 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", - "lineNumber": 37 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.ErrorEmbeddable.destroy", "type": "Function", + "tags": [], "label": "destroy", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 57 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.PanelNotFoundError", "type": "Class", "tags": [], @@ -3932,69 +4416,55 @@ }, " extends Error" ], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.PanelNotFoundError.code", "type": "string", + "tags": [], "label": "code", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.PanelNotFoundError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/errors.ts", - "lineNumber": 12 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "embeddable", "id": "def-public.defaultEmbeddableFactoryProvider", "type": "Function", - "children": [ - { - "id": "def-public.defaultEmbeddableFactoryProvider.$1", - "type": "CompoundType", - "label": "def", - "isRequired": true, - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactoryDefinition", - "text": "EmbeddableFactoryDefinition" - }, - "" - ], - "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", - "lineNumber": 22 - } - } - ], + "tags": [], + "label": "defaultEmbeddableFactoryProvider", + "description": [], "signature": [ "" + "" ], - "description": [], "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", - "lineNumber": 83 - } + "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", + "lineNumber": 22 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRenderer", + "type": "Function", + "tags": [], + "label": "EmbeddableRenderer", + "description": [ + "\nHelper react component to render an embeddable\nCan be used if you have an embeddable object or an embeddable factory\nSupports updating input by passing `input` prop\n" + ], "signature": [ ") => JSX.Element" ], - "description": [ - "\nHelper react component to render an embeddable\nCan be used if you have an embeddable object or an embeddable factory\nSupports updating input by passing `input` prop\n" - ], - "label": "EmbeddableRenderer", "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", "lineNumber": 82 }, - "tags": [ - "public" - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.isContextMenuTriggerContext", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.isContextMenuTriggerContext.$1", - "type": "Unknown", - "label": "context", - "isRequired": true, + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRenderer.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], "signature": [ - "unknown" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableRendererProps", + "text": "EmbeddableRendererProps" + }, + "" ], - "description": [], "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 115 - } + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", + "lineNumber": 83 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isContextMenuTriggerContext", + "type": "Function", + "tags": [], + "label": "isContextMenuTriggerContext", + "description": [], "signature": [ "(context: unknown) => context is ", { @@ -4160,39 +4645,44 @@ }, ">>" ], - "description": [], - "label": "isContextMenuTriggerContext", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 115 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.isEmbeddable", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.isEmbeddable.$1", + "parentPluginId": "embeddable", + "id": "def-public.isContextMenuTriggerContext.$1", "type": "Unknown", - "label": "x", - "isRequired": true, + "tags": [], + "label": "context", + "description": [], "signature": [ "unknown" ], - "description": [], "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", - "lineNumber": 11 - } + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 115 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(x: unknown) => x is ", - { - "pluginId": "embeddable", + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isEmbeddable", + "type": "Function", + "tags": [], + "label": "isEmbeddable", + "description": [], + "signature": [ + "(x: unknown) => x is ", + { + "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", @@ -4216,20 +4706,40 @@ }, ">" ], - "description": [], - "label": "isEmbeddable", "source": { "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", "lineNumber": 11 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.isEmbeddable.$1", + "type": "Unknown", + "tags": [], + "label": "x", + "description": [], + "signature": [ + "unknown" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", + "lineNumber": 11 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.isErrorEmbeddable", "type": "Function", + "tags": [], "label": "isErrorEmbeddable", + "description": [], "signature": [ "(embeddable: ", { @@ -4241,13 +4751,19 @@ }, " | TEmbeddable) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.isErrorEmbeddable.$1", "type": "CompoundType", + "tags": [], "label": "embeddable", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -4258,71 +4774,24 @@ }, " | TEmbeddable" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.isRangeSelectTriggerContext", "type": "Function", - "children": [ - { - "id": "def-public.isRangeSelectTriggerContext.$1", - "type": "CompoundType", - "label": "context", - "isRequired": true, - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ChartActionContext", - "text": "ChartActionContext" - }, - "<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ">>" - ], - "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 107 - } - } - ], + "tags": [], + "label": "isRangeSelectTriggerContext", + "description": [], "signature": [ "(context: ", { @@ -4365,57 +4834,19 @@ "text": "RangeSelectContext" } ], - "description": [], - "label": "isRangeSelectTriggerContext", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 106 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.isReferenceOrValueEmbeddable", - "type": "Function", - "label": "isReferenceOrValueEmbeddable", - "signature": [ - "(incoming: unknown) => boolean" - ], - "description": [], + "deprecated": false, "children": [ { - "id": "def-public.isReferenceOrValueEmbeddable.$1", - "type": "Unknown", - "label": "incoming", - "isRequired": true, - "signature": [ - "unknown" - ], - "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", - "lineNumber": 38 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", - "lineNumber": 37 - }, - "initialIsOpen": false - }, - { - "id": "def-public.isRowClickTriggerContext", - "type": "Function", - "children": [ - { - "id": "def-public.isRowClickTriggerContext.$1", + "parentPluginId": "embeddable", + "id": "def-public.isRangeSelectTriggerContext.$1", "type": "CompoundType", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -4450,13 +4881,61 @@ }, ">>" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 110 - } + "lineNumber": 107 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isReferenceOrValueEmbeddable", + "type": "Function", + "tags": [], + "label": "isReferenceOrValueEmbeddable", + "description": [], + "signature": [ + "(incoming: unknown) => boolean" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 37 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.isReferenceOrValueEmbeddable.$1", + "type": "Unknown", + "tags": [], + "label": "incoming", + "description": [], + "signature": [ + "unknown" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 38 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isRowClickTriggerContext", + "type": "Function", + "tags": [], + "label": "isRowClickTriggerContext", + "description": [], "signature": [ "(context: ", { @@ -4499,20 +4978,71 @@ "text": "RowClickContext" } ], - "description": [], - "label": "isRowClickTriggerContext", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 110 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.isRowClickTriggerContext.$1", + "type": "CompoundType", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ChartActionContext", + "text": "ChartActionContext" + }, + "<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">>" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 110 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.isSavedObjectEmbeddableInput", "type": "Function", + "tags": [], "label": "isSavedObjectEmbeddableInput", + "description": [], "signature": [ "(input: ", { @@ -4532,13 +5062,19 @@ }, ") => boolean" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.isSavedObjectEmbeddableInput.$1", "type": "CompoundType", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -4556,71 +5092,24 @@ "text": "SavedObjectEmbeddableInput" } ], - "description": [], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.isValueClickTriggerContext", "type": "Function", - "children": [ - { - "id": "def-public.isValueClickTriggerContext.$1", - "type": "CompoundType", - "label": "context", - "isRequired": true, - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ChartActionContext", - "text": "ChartActionContext" - }, - "<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ">>" - ], - "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 103 - } - } - ], + "tags": [], + "label": "isValueClickTriggerContext", + "description": [], "signature": [ "(context: ", { @@ -4663,20 +5152,71 @@ "text": "ValueClickContext" } ], - "description": [], - "label": "isValueClickTriggerContext", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 102 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.isValueClickTriggerContext.$1", + "type": "CompoundType", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ChartActionContext", + "text": "ChartActionContext" + }, + "<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">>" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 103 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.openAddPanelFlyout", "type": "Function", + "tags": [], "label": "openAddPanelFlyout", + "description": [], "signature": [ "(options: { embeddable: ", { @@ -4719,25 +5259,32 @@ "text": "EmbeddableInput" } ], - "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.openAddPanelFlyout.$1.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.openAddPanelFlyout.$1.options.embeddable", "type": "Object", + "tags": [], "label": "embeddable", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "lineNumber": 17 - }, "signature": [ { "pluginId": "embeddable", @@ -4763,18 +5310,20 @@ "text": "ContainerOutput" }, ">" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.openAddPanelFlyout.$1.options.getFactory", "type": "Function", + "tags": [], "label": "getFactory", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "lineNumber": 18 - }, "signature": [ " IterableIterator<", { @@ -4869,18 +5420,20 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.openAddPanelFlyout.$1.options.overlays", "type": "Object", + "tags": [], "label": "overlays", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "lineNumber": 20 - }, "signature": [ { "pluginId": "core", @@ -4889,18 +5442,20 @@ "section": "def-public.OverlayStart", "text": "OverlayStart" } - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 20 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.openAddPanelFlyout.$1.options.notifications", "type": "Object", + "tags": [], "label": "notifications", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "lineNumber": 21 - }, "signature": [ { "pluginId": "core", @@ -4909,56 +5464,58 @@ "section": "def-public.NotificationsStart", "text": "NotificationsStart" } - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.openAddPanelFlyout.$1.options.SavedObjectFinder", "type": "CompoundType", + "tags": [], "label": "SavedObjectFinder", "description": [], + "signature": [ + "React.ComponentType" + ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "lineNumber": 22 }, + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.openAddPanelFlyout.$1.options.showCreateNewMenu", + "type": "CompoundType", + "tags": [], + "label": "showCreateNewMenu", + "description": [], "signature": [ - "React.ComponentType" - ] + "boolean | undefined" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 23 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "lineNumber": 16 - } + ] } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.withEmbeddableSubscription", "type": "Function", - "children": [ - { - "id": "def-public.withEmbeddableSubscription.$1", - "type": "CompoundType", - "label": "WrappedComponent", - "isRequired": true, - "signature": [ - "React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>" - ], - "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx", - "lineNumber": 19 - } - } - ], + "tags": [], + "label": "withEmbeddableSubscription", + "description": [], "signature": [ ", ExtraProps = {}>(WrappedComponent: React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>) => React.ComponentType<{ embeddable: E; } & ExtraProps>" ], - "description": [], - "label": "withEmbeddableSubscription", "source": { "path": "src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx", "lineNumber": 13 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.withEmbeddableSubscription.$1", + "type": "CompoundType", + "tags": [], + "label": "WrappedComponent", + "description": [], + "signature": [ + "React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx", + "lineNumber": 19 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "embeddable", "id": "def-public.Adapters", "type": "Interface", + "tags": [], "label": "Adapters", "description": [ "\nThe interface that the adapters used to open an inspector have to fullfill." ], - "tags": [], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.Adapters.requests", "type": "Object", + "tags": [], "label": "requests", "description": [], - "source": { - "path": "src/plugins/inspector/common/adapters/types.ts", - "lineNumber": 15 - }, "signature": [ { "pluginId": "inspector", @@ -5034,33 +5611,39 @@ "text": "RequestAdapter" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 15 + }, + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.Adapters.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 16 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/common/adapters/types.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.ContainerInput", "type": "Interface", + "tags": [], "label": "ContainerInput", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -5078,33 +5661,35 @@ "text": "EmbeddableInput" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ContainerInput.hidePanelTitles", "type": "CompoundType", + "tags": [], "label": "hidePanelTitles", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 25 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ContainerInput.panels", "type": "Object", + "tags": [], "label": "panels", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "lineNumber": 26 - }, "signature": [ "{ [key: string]: ", { @@ -5123,19 +5708,23 @@ "text": "EmbeddableInput" }, " & { id: string; }>; }" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 26 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.ContainerOutput", "type": "Interface", + "tags": [], "label": "ContainerOutput", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -5153,72 +5742,80 @@ "text": "EmbeddableOutput" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ContainerOutput.embeddableLoaded", "type": "Object", + "tags": [], "label": "embeddableLoaded", "description": [], + "signature": [ + "{ [key: string]: boolean; }" + ], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 21 }, - "signature": [ - "{ [key: string]: boolean; }" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanelProps", "type": "Interface", + "tags": [], "label": "EmbeddableChildPanelProps", "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanelProps.embeddableId", "type": "string", + "tags": [], "label": "embeddableId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanelProps.className", "type": "string", + "tags": [], "label": "className", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanelProps.container", "type": "Object", + "tags": [], "label": "container", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "lineNumber": 21 - }, "signature": [ { "pluginId": "embeddable", @@ -5244,18 +5841,20 @@ "text": "ContainerOutput" }, ">" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableChildPanelProps.PanelComponent", "type": "Function", + "tags": [], "label": "PanelComponent", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "lineNumber": 22 - }, "signature": [ "React.FC<{ embeddable: ", { @@ -5282,19 +5881,23 @@ "text": "EmbeddableOutput" }, ">; hideHeader?: boolean | undefined; }>" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 22 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableContext", "type": "Interface", + "tags": [], "label": "EmbeddableContext", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -5305,76 +5908,82 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableContext.embeddable", "type": "Uncategorized", + "tags": [], "label": "embeddable", "description": [], + "signature": [ + "T" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 15 }, - "signature": [ - "T" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableEditorState", "type": "Interface", + "tags": [], "label": "EmbeddableEditorState", "description": [ "\nA state package that contains information an editor will need to create or edit an embeddable then redirect back." ], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableEditorState.originatingApp", "type": "string", + "tags": [], "label": "originatingApp", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableEditorState.embeddableId", "type": "string", + "tags": [], "label": "embeddableId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableEditorState.valueInput", "type": "Object", + "tags": [], "label": "valueInput", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", - "lineNumber": 21 - }, "signature": [ { "pluginId": "embeddable", @@ -5384,19 +5993,25 @@ "text": "EmbeddableInput" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 21 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory", "type": "Interface", + "tags": [], "label": "EmbeddableFactory", + "description": [ + "\nEmbeddableFactories create and initialize an embeddable instance" + ], "signature": [ { "pluginId": "embeddable", @@ -5423,48 +6038,50 @@ }, ">" ], - "description": [ - "\nEmbeddableFactories create and initialize an embeddable instance" - ], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 41 - } + "lineNumber": 42 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.isEditable", "type": "Function", + "tags": [], "label": "isEditable", "description": [ "\nReturns whether the current user should be allowed to edit this type of\nembeddable. Most of the time this should be based off the capabilities service, hence it's async." ], + "signature": [ + "() => Promise" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 47 + "lineNumber": 48 }, - "signature": [ - "() => Promise" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.savedObjectMetaData", "type": "Object", + "tags": [], "label": "savedObjectMetaData", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 49 - }, "signature": [ { "pluginId": "savedObjects", @@ -5474,112 +6091,200 @@ "text": "SavedObjectMetaData" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 50 + }, + "deprecated": false }, { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactory.grouping", + "type": "Array", "tags": [], + "label": "grouping", + "description": [ + "\nIndicates the grouping this factory should appear in a sub-menu. Example, this is used for grouping\noptions in the editors menu in Dashboard for creating new embeddables" + ], + "signature": [ + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.PresentableGrouping", + "text": "PresentableGrouping" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 56 + }, + "deprecated": false + }, + { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.isContainerType", "type": "boolean", + "tags": [], "label": "isContainerType", "description": [ "\nTrue if is this factory create embeddables that are Containers. Used in the add panel to\nconditionally show whether these can be added to another container. It's just not\nsupported right now, but once nested containers are officially supported we can probably get\nrid of this interface." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 57 - } + "lineNumber": 64 + }, + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.getDisplayName", "type": "Function", + "tags": [], "label": "getDisplayName", + "description": [ + "\nReturns a display name for this type of embeddable. Used in \"Create new... \" options\nin the add panel for containers." + ], "signature": [ "() => string" ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 70 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactory.getIconType", + "type": "Function", + "tags": [], + "label": "getIconType", "description": [ - "\nReturns a display name for this type of embeddable. Used in \"Create new... \" options\nin the add panel for containers." + "\nReturns an EUI Icon type to be displayed in a menu." + ], + "signature": [ + "() => string" ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 75 + }, + "deprecated": false, "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactory.getDescription", + "type": "Function", "tags": [], - "returnComment": [], + "label": "getDescription", + "description": [ + "\nReturns a description about the embeddable." + ], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 63 - } + "lineNumber": 80 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.canCreateNew", "type": "Function", + "tags": [], "label": "canCreateNew", - "signature": [ - "() => boolean" - ], "description": [ "\nIf false, this type of embeddable can't be created with the \"createNew\" functionality. Instead,\nuse createFromSavedObject, where an existing saved object must first exist." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => boolean" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 69 - } + "lineNumber": 86 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.getDefaultInput", "type": "Function", + "tags": [], "label": "getDefaultInput", - "signature": [ - "(partial: Partial) => Partial" - ], "description": [ "\nCan be used to get any default input, to be passed in to during the creation process. Default\ninput will not be stored in a parent container, so any inherited input from a container will trump\ndefault input parameters." ], + "signature": [ + "(partial: Partial) => Partial" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 94 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.getDefaultInput.$1", "type": "Object", + "tags": [], "label": "partial", - "isRequired": true, + "description": [], "signature": [ "Partial" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 77 - } + "lineNumber": 94 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 77 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.getExplicitInput", "type": "Function", + "tags": [], "label": "getExplicitInput", - "signature": [ - "() => Promise>" - ], "description": [ "\nCan be used to request explicit input from the user, to be passed in to `EmbeddableFactory:create`.\nExplicit input is stored on the parent container for this embeddable. It overrides any inherited\ninput passed down from the parent container." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => Promise>" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 84 - } + "lineNumber": 101 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.createFromSavedObject", "type": "Function", + "tags": [], "label": "createFromSavedObject", + "description": [ + "\nCreates a new embeddable instance based off the saved object id." + ], "signature": [ "(savedObjectId: string, input: Partial, parent?: ", { @@ -5615,45 +6320,55 @@ }, ">" ], - "description": [ - "\nCreates a new embeddable instance based off the saved object id." - ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 110 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.createFromSavedObject.$1", "type": "string", + "tags": [], "label": "savedObjectId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 94 - } + "lineNumber": 111 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.createFromSavedObject.$2", "type": "Object", + "tags": [], "label": "input", - "isRequired": true, - "signature": [ - "Partial" - ], "description": [ "- some input may come from a parent, or user, if it's not stored with the saved object. For example, the time\nrange of the parent container." ], + "signature": [ + "Partial" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 95 - } + "lineNumber": 112 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.createFromSavedObject.$3", "type": "Object", + "tags": [], "label": "parent", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -5680,24 +6395,25 @@ }, "> | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 96 - } + "lineNumber": 113 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 93 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.create", "type": "Function", + "tags": [], "label": "create", + "description": [ + "\nResolves to undefined if a new Embeddable cannot be directly created and the user will instead be redirected\nelsewhere.\n\nThis will likely change in future iterations when we improve in place editing capabilities." + ], "signature": [ "(initialInput: TEmbeddableInput, parent?: ", { @@ -5733,29 +6449,36 @@ }, " | undefined>" ], - "description": [ - "\nResolves to undefined if a new Embeddable cannot be directly created and the user will instead be redirected\nelsewhere.\n\nThis will likely change in future iterations when we improve in place editing capabilities." - ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 122 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.create.$1", "type": "Uncategorized", + "tags": [], "label": "initialInput", - "isRequired": true, + "description": [], "signature": [ "TEmbeddableInput" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 106 - } + "lineNumber": 123 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.create.$2", "type": "Object", + "tags": [], "label": "parent", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -5782,239 +6505,260 @@ }, "> | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 107 - } + "lineNumber": 124 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 105 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableInstanceConfiguration", "type": "Interface", + "tags": [], "label": "EmbeddableInstanceConfiguration", "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableInstanceConfiguration.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 19 - } + "lineNumber": 20 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableInstanceConfiguration.savedObjectId", "type": "string", + "tags": [], "label": "savedObjectId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 20 + "lineNumber": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput", "type": "Interface", + "tags": [], "label": "EmbeddableOutput", "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.loading", "type": "CompoundType", + "tags": [], "label": "loading", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 23 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.error", "type": "Object", + "tags": [], "label": "error", "description": [], + "signature": [ + "EmbeddableError", + " | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 25 }, - "signature": [ - "EmbeddableError", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.editUrl", "type": "string", + "tags": [], "label": "editUrl", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", - "lineNumber": 26 - }, "signature": [ "string | undefined" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 26 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.editApp", "type": "string", + "tags": [], "label": "editApp", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 27 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.editPath", "type": "string", + "tags": [], "label": "editPath", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 28 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.defaultTitle", "type": "string", + "tags": [], "label": "defaultTitle", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 29 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.title", "type": "string", + "tags": [], "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 30 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.editable", "type": "CompoundType", + "tags": [], "label": "editable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 31 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.savedObjectId", "type": "string", + "tags": [], "label": "savedObjectId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 32 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePackageState", "type": "Interface", + "tags": [], "label": "EmbeddablePackageState", "description": [ "\nA state package that contains all fields necessary to create or update an embeddable by reference or by value in a container." ], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePackageState.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 35 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePackageState.input", "type": "CompoundType", + "tags": [], "label": "input", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", - "lineNumber": 36 - }, "signature": [ "Optional", "<", @@ -6036,46 +6780,52 @@ "text": "SavedObjectEmbeddableInput" }, ", \"id\">" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 36 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePackageState.embeddableId", "type": "string", + "tags": [], "label": "embeddableId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 37 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetupDependencies", "type": "Interface", + "tags": [], "label": "EmbeddableSetupDependencies", "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetupDependencies.uiActions", "type": "Object", + "tags": [], "label": "uiActions", "description": [], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 54 - }, "signature": [ "Pick<", { @@ -6086,32 +6836,36 @@ "text": "UiActionsService" }, ", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 54 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStartDependencies", "type": "Interface", + "tags": [], "label": "EmbeddableStartDependencies", "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStartDependencies.uiActions", "type": "Object", + "tags": [], "label": "uiActions", "description": [], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 58 - }, "signature": [ "Pick<", { @@ -6132,18 +6886,20 @@ "text": "UiActionsService" }, ">>" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 58 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStartDependencies.inspector", "type": "Object", + "tags": [], "label": "inspector", "description": [], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 59 - }, "signature": [ { "pluginId": "inspector", @@ -6152,19 +6908,23 @@ "section": "def-public.Start", "text": "Start" } - ] + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 59 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EnhancementRegistryDefinition", "type": "Interface", + "tags": [], "label": "EnhancementRegistryDefinition", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -6183,31 +6943,35 @@ }, "

>" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EnhancementRegistryDefinition.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/types.ts", "lineNumber": 28 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/types.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.IContainer", "type": "Interface", + "tags": [], "label": "IContainer", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -6226,13 +6990,21 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.IContainer.untilEmbeddableLoaded", "type": "Function", + "tags": [], "label": "untilEmbeddableLoaded", + "description": [ + "\nCall if you want to wait until an embeddable with that id has finished loading." + ], "signature": [ "" ], - "description": [ - "\nCall if you want to wait until an embeddable with that id has finished loading." - ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.IContainer.untilEmbeddableLoaded.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 40 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "lineNumber": 39 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IContainer.getInputForChild", "type": "Function", + "tags": [], "label": "getInputForChild", + "description": [ + "\nReturns the input for the given child. Uses a combination of explicit input\nfor the child stored on the parent and derived/inherited input taken from the\ncontainer itself." + ], "signature": [ "(id: string) => EEI" ], - "description": [ - "\nReturns the input for the given child. Uses a combination of explicit input\nfor the child stored on the parent and derived/inherited input taken from the\ncontainer itself." - ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.IContainer.getInputForChild.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "lineNumber": 49 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IContainer.updateInputForChild", "type": "Function", + "tags": [], "label": "updateInputForChild", + "description": [ + "\nChanges the input for a given child. Note, this will override any inherited state taken from\nthe container itself." + ], "signature": [ "(id: string, changes: Partial) => void" ], - "description": [ - "\nChanges the input for a given child. Note, this will override any inherited state taken from\nthe container itself." - ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.IContainer.updateInputForChild.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.IContainer.updateInputForChild.$2", "type": "Object", + "tags": [], "label": "changes", - "isRequired": true, + "description": [], "signature": [ "Partial" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "lineNumber": 57 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IContainer.getChild", "type": "Function", + "tags": [], "label": "getChild", + "description": [ + "\nReturns the child embeddable with the given id." + ], "signature": [ " void" - ], "description": [ "\nRemoves the embeddable with the given id." ], + "signature": [ + "(embeddableId: string) => void" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.IContainer.removeEmbeddable.$1", "type": "string", + "tags": [], "label": "embeddableId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 69 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "lineNumber": 69 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IContainer.addNewEmbeddable", "type": "Function", + "tags": [], "label": "addNewEmbeddable", + "description": [ + "\nAdds a new embeddable to the container. `explicitInput` may partially specify the required embeddable input,\nbut the remainder must come from inherited container state." + ], "signature": [ "" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "lineNumber": 75 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable", "type": "Interface", + "tags": [], "label": "IEmbeddable", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -6602,13 +7404,17 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.isContainer", "type": "boolean", + "tags": [], "label": "isContainer", "description": [ "\nIs this embeddable an instance of a Container class, can it contain\nnested embeddables?" @@ -6616,20 +7422,18 @@ "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 43 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.parent", "type": "Object", + "tags": [], "label": "parent", "description": [ "\nIf this embeddable is nested inside a container, this will contain\na reference to its parent." ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", - "lineNumber": 49 - }, "signature": [ { "pluginId": "embeddable", @@ -6655,12 +7459,18 @@ "text": "ContainerOutput" }, "> | undefined" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 49 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nThe type of embeddable, this is what will be used to take a serialized\nembeddable and find the correct factory for which to create an instance of it." @@ -6668,12 +7478,14 @@ "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nA unique identifier for this embeddable. Mainly only used by containers to map their\nPanel States to a child embeddable instance." @@ -6681,60 +7493,72 @@ "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 61 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.runtimeId", "type": "number", + "tags": [], "label": "runtimeId", "description": [ "\nUnique ID an embeddable is assigned each time it is initialized. This ID\nis different for different instances of the same embeddable. For example,\nif the same dashboard is rendered twice on the screen, all embeddable\ninstances will have a unique `runtimeId`." ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 69 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.enhancements", "type": "Uncategorized", + "tags": [], "label": "enhancements", "description": [ "\nExtra abilities added to Embeddable by `*_enhanced` plugins." ], + "signature": [ + "object | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 74 }, - "signature": [ - "object | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.fatalError", "type": "Object", + "tags": [], "label": "fatalError", "description": [ "\nIf this embeddable has encountered a fatal error, that error will be stored here" ], + "signature": [ + "Error | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 79 }, - "signature": [ - "Error | undefined" - ] + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.getIsContainer", "type": "Function", + "tags": [], "label": "getIsContainer", + "description": [ + "\nA functional representation of the isContainer variable, but helpful for typescript to\nknow the shape if this returns true" + ], "signature": [ "() => this is ", { @@ -6762,148 +7586,165 @@ }, ">" ], - "description": [ - "\nA functional representation of the isContainer variable, but helpful for typescript to\nknow the shape if this returns true" - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 85 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.getInput", "type": "Function", + "tags": [], "label": "getInput", - "signature": [ - "() => Readonly" - ], "description": [ "\nGet the input used to instantiate this embeddable. The input is a serialized representation of\nthis embeddable instance and can be used to clone or re-instantiate it. Input state:\n\n- Can be updated externally\n- Can change multiple times for a single embeddable instance.\n\nExamples: title, pie slice colors, custom search columns and sort order." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => Readonly" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 96 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.getOutput", "type": "Function", + "tags": [], "label": "getOutput", - "signature": [ - "() => Readonly" - ], "description": [ "\nOutput state is:\n\n- State that should not change once the embeddable is instantiated, or\n- State that is derived from the input state, or\n- State that only the embeddable instance itself knows about, or the factory.\n\nExamples: editUrl, title taken from a saved object, if your input state was first name and\n last name, your output state could be greeting." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => Readonly" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 108 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.updateInput", "type": "Function", + "tags": [], "label": "updateInput", - "signature": [ - "(changes: Partial) => void" - ], "description": [ "\nUpdates input state with the given changes." ], + "signature": [ + "(changes: Partial) => void" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 114 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.updateInput.$1", "type": "Object", + "tags": [], "label": "changes", - "isRequired": true, + "description": [], "signature": [ "Partial" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 114 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", - "lineNumber": 114 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.getInput$", "type": "Function", + "tags": [], "label": "getInput$", + "description": [ + "\nReturns an observable which will be notified when input state changes." + ], "signature": [ "() => Readonly<", "Observable", ">" ], - "description": [ - "\nReturns an observable which will be notified when input state changes." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 119 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.getOutput$", "type": "Function", + "tags": [], "label": "getOutput$", + "description": [ + "\nReturns an observable which will be notified when output state changes." + ], "signature": [ "() => Readonly<", "Observable", ">" ], - "description": [ - "\nReturns an observable which will be notified when output state changes." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 124 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.getTitle", "type": "Function", + "tags": [], "label": "getTitle", - "signature": [ - "() => string | undefined" - ], "description": [ "\nReturns the title of this embeddable." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 129 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.getRoot", "type": "Function", + "tags": [], "label": "getRoot", + "description": [ + "\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent." + ], "signature": [ "() => ", { @@ -6946,72 +7787,83 @@ "text": "ContainerInput" } ], - "description": [ - "\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 135 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.render", "type": "Function", + "tags": [], "label": "render", - "signature": [ - "(domNode: Element | HTMLElement) => void" - ], "description": [ "\nRenders the embeddable at the given node." ], + "signature": [ + "(domNode: Element | HTMLElement) => void" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 141 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.render.$1", "type": "CompoundType", + "tags": [], "label": "domNode", - "isRequired": true, + "description": [], "signature": [ "Element | HTMLElement" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 141 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", - "lineNumber": 141 - } + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.reload", "type": "Function", + "tags": [], "label": "reload", - "signature": [ - "() => void" - ], "description": [ "\nReload the embeddable so output and rendering is up to date. Especially relevant\nif the embeddable takes relative time as input (e.g. now to now-15)" ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 147 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.getInspectorAdapters", "type": "Function", + "tags": [ + "return" + ], "label": "getInspectorAdapters", + "description": [ + "\nAn embeddable can return inspector adapters if it wants the inspector to be\navailable via the context menu of that panel." + ], "signature": [ "() => ", { @@ -7023,96 +7875,98 @@ }, " | undefined" ], - "description": [ - "\nAn embeddable can return inspector adapters if it wants the inspector to be\navailable via the context menu of that panel." - ], - "children": [], - "tags": [ - "return" - ], - "returnComment": [ - "Inspector adapters that will be used to open an inspector for." - ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 154 - } + }, + "deprecated": false, + "children": [], + "returnComment": [ + "Inspector adapters that will be used to open an inspector for." + ] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.destroy", "type": "Function", + "tags": [], "label": "destroy", - "signature": [ - "() => void" - ], "description": [ "\nCleans up subscriptions, destroy nodes mounted from calls to render." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 159 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.supportedTriggers", "type": "Function", + "tags": [], "label": "supportedTriggers", - "signature": [ - "() => string[]" - ], "description": [ "\nList of triggers that this embeddable will execute." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => string[]" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 164 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.OutputSpec", "type": "Interface", + "tags": [], "label": "OutputSpec", "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-public.OutputSpec.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 24 + "lineNumber": 25 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.PanelState", "type": "Interface", + "tags": [], "label": "PanelState", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -7123,117 +7977,135 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.PanelState.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.PanelState.explicitInput", "type": "CompoundType", + "tags": [], "label": "explicitInput", "description": [], + "signature": [ + "Partial & { id: string; }" + ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 62 }, - "signature": [ - "Partial & { id: string; }" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/common/types.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.PropertySpec", "type": "Interface", + "tags": [], "label": "PropertySpec", "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/types.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.PropertySpec.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.PropertySpec.accessPath", "type": "string", + "tags": [], "label": "accessPath", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.PropertySpec.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.PropertySpec.description", "type": "string", + "tags": [], "label": "description", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.PropertySpec.value", "type": "string", + "tags": [], "label": "value", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 22 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/types.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.RangeSelectContext", "type": "Interface", + "tags": [], "label": "RangeSelectContext", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -7244,33 +8116,35 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.RangeSelectContext.embeddable", "type": "Uncategorized", + "tags": [], "label": "embeddable", "description": [], + "signature": [ + "T | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 33 }, - "signature": [ - "T | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.RangeSelectContext.data", "type": "Object", + "tags": [], "label": "data", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 34 - }, "signature": [ "{ table: ", { @@ -7281,19 +8155,25 @@ "text": "Datatable" }, "; column: number; range: number[]; timeFieldName?: string | undefined; }" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 34 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 32 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.ReferenceOrValueEmbeddable", "type": "Interface", + "tags": [], "label": "ReferenceOrValueEmbeddable", + "description": [ + "\nAny embeddable that implements this interface will be able to use input that is\neither by reference (backed by a saved object) OR by value, (provided\nby the container)." + ], "signature": [ { "pluginId": "embeddable", @@ -7304,72 +8184,76 @@ }, "" ], - "description": [ - "\nAny embeddable that implements this interface will be able to use input that is\neither by reference (backed by a saved object) OR by value, (provided\nby the container)." - ], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ReferenceOrValueEmbeddable.inputIsRefType", "type": "Function", + "tags": [], "label": "inputIsRefType", "description": [ "\ndetermines whether the input is by value or by reference." ], + "signature": [ + "(input: ValTypeInput | RefTypeInput) => input is RefTypeInput" + ], "source": { "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 24 }, - "signature": [ - "(input: ValTypeInput | RefTypeInput) => input is RefTypeInput" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ReferenceOrValueEmbeddable.getInputAsValueType", "type": "Function", + "tags": [], "label": "getInputAsValueType", "description": [ "\nGets the embeddable's current input as its Value type" ], + "signature": [ + "() => Promise" + ], "source": { "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 29 }, - "signature": [ - "() => Promise" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ReferenceOrValueEmbeddable.getInputAsRefType", "type": "Function", + "tags": [], "label": "getInputAsRefType", "description": [ "\nGets the embeddable's current input as its Reference type" ], + "signature": [ + "() => Promise" + ], "source": { "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 34 }, - "signature": [ - "() => Promise" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.SavedObjectEmbeddableInput", "type": "Interface", + "tags": [], "label": "SavedObjectEmbeddableInput", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -7387,31 +8271,35 @@ "text": "EmbeddableInput" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.SavedObjectEmbeddableInput.savedObjectId", "type": "string", + "tags": [], "label": "savedObjectId", "description": [], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 12 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.ValueClickContext", "type": "Interface", + "tags": [], "label": "ValueClickContext", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -7422,33 +8310,35 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ValueClickContext.embeddable", "type": "Uncategorized", + "tags": [], "label": "embeddable", "description": [], + "signature": [ + "T | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 19 }, - "signature": [ - "T | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ValueClickContext.data", "type": "Object", + "tags": [], "label": "data", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 20 - }, "signature": [ "{ data: { table: Pick<", { @@ -7459,88 +8349,94 @@ "text": "Datatable" }, ", \"rows\" | \"columns\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 20 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 18 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "embeddable", "id": "def-public.ViewMode", "type": "Enum", - "label": "ViewMode", "tags": [], + "label": "ViewMode", "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 11 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ACTION_ADD_PANEL", "type": "string", + "tags": [], "label": "ACTION_ADD_PANEL", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "lineNumber": 17 - }, "signature": [ "\"ACTION_ADD_PANEL\"" ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 17 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ACTION_EDIT_PANEL", "type": "string", + "tags": [], "label": "ACTION_EDIT_PANEL", "description": [], + "signature": [ + "\"editPanel\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 25 }, - "signature": [ - "\"editPanel\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.ATTRIBUTE_SERVICE_KEY", "type": "string", + "tags": [], "label": "ATTRIBUTE_SERVICE_KEY", "description": [ "\nThe attribute service is a shared, generic service that embeddables can use to provide the functionality\nrequired to fulfill the requirements of the ReferenceOrValueEmbeddable interface. The attribute_service\ncan also be used as a higher level wrapper to transform an embeddable input shape that references a saved object\ninto an embeddable input shape that contains that saved object's attributes by value." ], + "signature": [ + "\"attributes\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 30 }, - "signature": [ - "\"attributes\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.ChartActionContext", "type": "Type", - "label": "ChartActionContext", "tags": [], + "label": "ChartActionContext", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 42 - }, "signature": [ { "pluginId": "embeddable", @@ -7566,63 +8462,71 @@ "text": "RowClickContext" } ], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 42 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.CONTEXT_MENU_TRIGGER", "type": "string", + "tags": [], "label": "CONTEXT_MENU_TRIGGER", "description": [], + "signature": [ + "\"CONTEXT_MENU_TRIGGER\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 47 }, - "signature": [ - "\"CONTEXT_MENU_TRIGGER\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactoryDefinition", "type": "Type", - "label": "EmbeddableFactoryDefinition", "tags": [], + "label": "EmbeddableFactoryDefinition", "description": [], + "signature": [ + "Pick, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts", "lineNumber": 14 }, - "signature": [ - "Pick, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\">>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableInput", "type": "Type", - "label": "EmbeddableInput", "tags": [], + "label": "EmbeddableInput", "description": [], + "signature": [ + "{ viewMode?: ViewMode | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: SerializableState | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }" + ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 16 }, - "signature": [ - "{ viewMode?: ViewMode | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: SerializableState | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddablePanelHOC", "type": "Type", - "label": "EmbeddablePanelHOC", "tags": [], + "label": "EmbeddablePanelHOC", "description": [], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 98 - }, "signature": [ "(props: React.PropsWithChildren<{ embeddable: ", { @@ -7650,246 +8554,288 @@ }, ">; hideHeader?: boolean | undefined; }>, context: any) => React.ReactElement | null" ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 98 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableRendererProps", "type": "Type", - "label": "EmbeddableRendererProps", "tags": [], + "label": "EmbeddableRendererProps", "description": [ "\nThis type is a publicly exposed props of {@link EmbeddableRenderer}\nUnion is used to validate that or factory or embeddable is passed in, but it can't be both simultaneously\nIn case when embeddable is passed in, input is optional, because there is already an input inside of embeddable object\nIn case when factory is used, then input is required, because it will be used as initial input to create an embeddable object" ], + "signature": [ + "EmbeddableRendererPropsWithEmbeddable | EmbeddableRendererWithFactory" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", "lineNumber": 21 }, - "signature": [ - "EmbeddableRendererPropsWithEmbeddable | EmbeddableRendererWithFactory" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.PANEL_BADGE_TRIGGER", "type": "string", + "tags": [], "label": "PANEL_BADGE_TRIGGER", "description": [], + "signature": [ + "\"PANEL_BADGE_TRIGGER\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 58 }, - "signature": [ - "\"PANEL_BADGE_TRIGGER\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.PANEL_NOTIFICATION_TRIGGER", "type": "string", + "tags": [], "label": "PANEL_NOTIFICATION_TRIGGER", "description": [], + "signature": [ + "\"PANEL_NOTIFICATION_TRIGGER\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 69 }, - "signature": [ - "\"PANEL_NOTIFICATION_TRIGGER\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.SELECT_RANGE_TRIGGER", "type": "string", + "tags": [], "label": "SELECT_RANGE_TRIGGER", "description": [], + "signature": [ + "\"SELECT_RANGE_TRIGGER\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 80 }, - "signature": [ - "\"SELECT_RANGE_TRIGGER\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.VALUE_CLICK_TRIGGER", "type": "string", + "tags": [], "label": "VALUE_CLICK_TRIGGER", "description": [], + "signature": [ + "\"VALUE_CLICK_TRIGGER\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 91 }, - "signature": [ - "\"VALUE_CLICK_TRIGGER\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger", "type": "Object", "tags": [], + "label": "contextMenuTrigger", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 49 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 50 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger.description", "type": "string", + "tags": [], "label": "description", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 53 - } + }, + "deprecated": false } ], - "description": [], - "label": "contextMenuTrigger", - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger", "type": "Object", "tags": [], + "label": "panelBadgeTrigger", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 60 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 61 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger.description", "type": "string", + "tags": [], "label": "description", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 64 - } + }, + "deprecated": false } ], - "description": [], - "label": "panelBadgeTrigger", - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 59 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger", "type": "Object", "tags": [], + "label": "panelNotificationTrigger", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 71 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 72 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger.description", "type": "string", + "tags": [], "label": "description", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 75 - } + }, + "deprecated": false } ], - "description": [], - "label": "panelNotificationTrigger", - "source": { - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", - "lineNumber": 70 - }, "initialIsOpen": false } ], "setup": { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup", "type": "Interface", + "tags": [], "label": "EmbeddableSetup", "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup.registerEmbeddableFactory", "type": "Function", + "tags": [], "label": "registerEmbeddableFactory", "description": [], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 63 - }, "signature": [ ") => void" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 71 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup.setCustomEmbeddableFactoryProvider", "type": "Function", + "tags": [], "label": "setCustomEmbeddableFactoryProvider", "description": [], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 72 - }, "signature": [ "(customProvider: ", "EmbeddableFactoryProvider", ") => void" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 72 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 62 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStart", "type": "Interface", + "tags": [], "label": "EmbeddableStart", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8017,19 +8971,19 @@ }, ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 75 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStart.getEmbeddableFactory", "type": "Function", + "tags": [], "label": "getEmbeddableFactory", "description": [], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 76 - }, "signature": [ " IterableIterator<", { @@ -8124,18 +9080,20 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } - ] + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 83 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStart.EmbeddablePanel", "type": "Function", + "tags": [], "label": "EmbeddablePanel", "description": [], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 84 - }, "signature": [ "React.FC<{ embeddable: ", { @@ -8162,18 +9120,20 @@ "text": "EmbeddableOutput" }, ">; hideHeader?: boolean | undefined; }>" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 84 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStart.getStateTransfer", "type": "Function", + "tags": [], "label": "getStateTransfer", "description": [], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 85 - }, "signature": [ "(storage?: ", { @@ -8191,18 +9151,20 @@ "section": "def-public.EmbeddableStateTransfer", "text": "EmbeddableStateTransfer" } - ] + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 85 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStart.getAttributeService", "type": "Function", + "tags": [], "label": "getAttributeService", "description": [], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 86 - }, "signature": [ "(type: string, options: ", "AttributeServiceOptions" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 86 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/plugin.tsx", - "lineNumber": 75 - }, "lifecycle": "start", "initialIsOpen": true } @@ -8254,9 +9217,12 @@ "functions": [], "interfaces": [ { + "parentPluginId": "embeddable", "id": "def-server.EmbeddableRegistryDefinition", "type": "Interface", + "tags": [], "label": "EmbeddableRegistryDefinition", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8275,31 +9241,35 @@ }, "

>" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/server/types.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-server.EmbeddableRegistryDefinition.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/server/types.ts", "lineNumber": 32 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/server/types.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-server.EnhancementRegistryDefinition", "type": "Interface", + "tags": [], "label": "EnhancementRegistryDefinition", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8318,25 +9288,26 @@ }, "

>" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/server/types.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-server.EnhancementRegistryDefinition.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/server/types.ts", "lineNumber": 21 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/server/types.ts", - "lineNumber": 19 - }, "initialIsOpen": false } ], @@ -8344,9 +9315,12 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "embeddable", "id": "def-server.EmbeddableSetup", "type": "Interface", + "tags": [], "label": "EmbeddableSetup", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8373,19 +9347,19 @@ }, ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/server/plugin.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-server.EmbeddableSetup.registerEmbeddableFactory", "type": "Function", + "tags": [], "label": "registerEmbeddableFactory", "description": [], - "source": { - "path": "src/plugins/embeddable/server/plugin.ts", - "lineNumber": 28 - }, "signature": [ "(factory: ", { @@ -8404,18 +9378,20 @@ "text": "EmbeddableStateWithType" }, ">) => void" - ] + ], + "source": { + "path": "src/plugins/embeddable/server/plugin.ts", + "lineNumber": 28 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-server.EmbeddableSetup.registerEnhancement", "type": "Function", + "tags": [], "label": "registerEnhancement", "description": [], - "source": { - "path": "src/plugins/embeddable/server/plugin.ts", - "lineNumber": 29 - }, "signature": [ "(enhancement: ", { @@ -8434,14 +9410,33 @@ "text": "SerializableState" }, ">) => void" - ] + ], + "source": { + "path": "src/plugins/embeddable/server/plugin.ts", + "lineNumber": 29 + }, + "deprecated": false } ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "embeddable", + "id": "def-server.EmbeddableStart", + "type": "Type", + "tags": [], + "label": "EmbeddableStart", + "description": [], + "signature": [ + "PersistableStateService" + ], "source": { "path": "src/plugins/embeddable/server/plugin.ts", - "lineNumber": 27 + "lineNumber": 32 }, - "lifecycle": "setup", + "deprecated": false, + "lifecycle": "start", "initialIsOpen": true } }, @@ -8449,30 +9444,12 @@ "classes": [], "functions": [ { + "parentPluginId": "embeddable", "id": "def-common.extractBaseEmbeddableInput", "type": "Function", - "children": [ - { - "id": "def-common.extractBaseEmbeddableInput.$1", - "type": "CompoundType", - "label": "state", - "isRequired": true, - "signature": [ - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableStateWithType", - "text": "EmbeddableStateWithType" - } - ], - "description": [], - "source": { - "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", - "lineNumber": 20 - } - } - ], + "tags": [], + "label": "extractBaseEmbeddableInput", + "description": [], "signature": [ "(state: ", { @@ -8494,41 +9471,46 @@ "SavedObjectReference", "[]; }" ], - "description": [], - "label": "extractBaseEmbeddableInput", "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 20 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getExtractFunction", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.getExtractFunction.$1", - "type": "Object", - "label": "embeddables", - "isRequired": true, + "parentPluginId": "embeddable", + "id": "def-common.extractBaseEmbeddableInput.$1", + "type": "CompoundType", + "tags": [], + "label": "state", + "description": [], "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-common.CommonEmbeddableStartContract", - "text": "CommonEmbeddableStartContract" + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" } ], - "description": [], "source": { - "path": "src/plugins/embeddable/common/lib/extract.ts", - "lineNumber": 13 - } + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 20 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-common.getExtractFunction", + "type": "Function", + "tags": [], + "label": "getExtractFunction", + "description": [], "signature": [ "(embeddables: ", { @@ -8558,25 +9540,19 @@ "SavedObjectReference", "[]; }" ], - "description": [], - "label": "getExtractFunction", "source": { "path": "src/plugins/embeddable/common/lib/extract.ts", "lineNumber": 13 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getInjectFunction", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.getInjectFunction.$1", + "parentPluginId": "embeddable", + "id": "def-common.getExtractFunction.$1", "type": "Object", + "tags": [], "label": "embeddables", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8586,13 +9562,24 @@ "text": "CommonEmbeddableStartContract" } ], - "description": [], "source": { - "path": "src/plugins/embeddable/common/lib/inject.ts", - "lineNumber": 14 - } + "path": "src/plugins/embeddable/common/lib/extract.ts", + "lineNumber": 13 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-common.getInjectFunction", + "type": "Function", + "tags": [], + "label": "getInjectFunction", + "description": [], "signature": [ "(embeddables: ", { @@ -8621,25 +9608,19 @@ "text": "EmbeddableStateWithType" } ], - "description": [], - "label": "getInjectFunction", "source": { "path": "src/plugins/embeddable/common/lib/inject.ts", "lineNumber": 14 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getMigrateFunction", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.getMigrateFunction.$1", + "parentPluginId": "embeddable", + "id": "def-common.getInjectFunction.$1", "type": "Object", + "tags": [], "label": "embeddables", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8649,13 +9630,24 @@ "text": "CommonEmbeddableStartContract" } ], - "description": [], "source": { - "path": "src/plugins/embeddable/common/lib/migrate.ts", - "lineNumber": 13 - } + "path": "src/plugins/embeddable/common/lib/inject.ts", + "lineNumber": 14 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-common.getMigrateFunction", + "type": "Function", + "tags": [], + "label": "getMigrateFunction", + "description": [], "signature": [ "(embeddables: ", { @@ -8682,25 +9674,78 @@ "text": "SerializableState" } ], - "description": [], - "label": "getMigrateFunction", "source": { - "path": "src/plugins/embeddable/common/lib/migrate.ts", - "lineNumber": 13 + "path": "src/plugins/embeddable/common/lib/migrate.ts", + "lineNumber": 13 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-common.getMigrateFunction.$1", + "type": "Object", + "tags": [], + "label": "embeddables", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" + } + ], + "source": { + "path": "src/plugins/embeddable/common/lib/migrate.ts", + "lineNumber": 13 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-common.getTelemetryFunction", + "type": "Function", + "tags": [], + "label": "getTelemetryFunction", + "description": [], + "signature": [ + "(embeddables: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" + }, + ") => (state: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + ", telemetryData?: Record) => Record" + ], + "source": { + "path": "src/plugins/embeddable/common/lib/telemetry.ts", + "lineNumber": 12 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getTelemetryFunction", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-common.getTelemetryFunction.$1", "type": "Object", + "tags": [], "label": "embeddables", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8710,51 +9755,57 @@ "text": "CommonEmbeddableStartContract" } ], - "description": [], "source": { "path": "src/plugins/embeddable/common/lib/telemetry.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-common.injectBaseEmbeddableInput", + "type": "Function", + "tags": [], + "label": "injectBaseEmbeddableInput", + "description": [], "signature": [ - "(embeddables: ", + "(state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-common.CommonEmbeddableStartContract", - "text": "CommonEmbeddableStartContract" + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" }, - ") => (state: ", + ", references: ", + "SavedObjectReference", + "[]) => ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" - }, - ", telemetryData?: Record) => Record" + } ], - "description": [], - "label": "getTelemetryFunction", "source": { - "path": "src/plugins/embeddable/common/lib/telemetry.ts", - "lineNumber": 12 + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 24 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.injectBaseEmbeddableInput", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-common.injectBaseEmbeddableInput.$1", "type": "CompoundType", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8764,62 +9815,42 @@ "text": "EmbeddableStateWithType" } ], - "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-common.injectBaseEmbeddableInput.$2", "type": "Array", + "tags": [], "label": "references", - "isRequired": true, + "description": [], "signature": [ "SavedObjectReference", "[]" ], - "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 26 - } - } - ], - "signature": [ - "(state: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableStateWithType", - "text": "EmbeddableStateWithType" - }, - ", references: ", - "SavedObjectReference", - "[]) => ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableStateWithType", - "text": "EmbeddableStateWithType" + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "injectBaseEmbeddableInput", - "source": { - "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", - "lineNumber": 24 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-common.isSavedObjectEmbeddableInput", "type": "Function", + "tags": [], "label": "isSavedObjectEmbeddableInput", + "description": [], "signature": [ "(input: ", { @@ -8839,13 +9870,19 @@ }, ") => boolean" ], - "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-common.isSavedObjectEmbeddableInput.$1", "type": "CompoundType", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8863,30 +9900,48 @@ "text": "SavedObjectEmbeddableInput" } ], - "description": [], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-common.telemetryBaseEmbeddableInput", "type": "Function", + "tags": [], + "label": "telemetryBaseEmbeddableInput", + "description": [], + "signature": [ + "(state: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + ", telemetryData: Record) => Record" + ], + "source": { + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "embeddable", "id": "def-common.telemetryBaseEmbeddableInput.$1", "type": "CompoundType", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8896,96 +9951,91 @@ "text": "EmbeddableStateWithType" } ], - "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-common.telemetryBaseEmbeddableInput.$2", "type": "Object", + "tags": [], "label": "telemetryData", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(state: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableStateWithType", - "text": "EmbeddableStateWithType" - }, - ", telemetryData: Record) => Record" - ], - "description": [], - "label": "telemetryBaseEmbeddableInput", - "source": { - "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", - "lineNumber": 13 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "embeddable", "id": "def-common.CommonEmbeddableStartContract", "type": "Interface", + "tags": [], "label": "CommonEmbeddableStartContract", "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory", "type": "Function", + "tags": [], "label": "getEmbeddableFactory", "description": [], + "signature": [ + "(embeddableFactoryId: string) => any" + ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 70 }, - "signature": [ - "(embeddableFactoryId: string) => any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-common.CommonEmbeddableStartContract.getEnhancement", "type": "Function", + "tags": [], "label": "getEnhancement", "description": [], + "signature": [ + "(enhancementId: string) => any" + ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 71 }, - "signature": [ - "(enhancementId: string) => any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/common/types.ts", - "lineNumber": 69 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-common.PanelState", "type": "Interface", + "tags": [], "label": "PanelState", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8996,45 +10046,51 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-common.PanelState.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-common.PanelState.explicitInput", "type": "CompoundType", + "tags": [], "label": "explicitInput", "description": [], + "signature": [ + "Partial & { id: string; }" + ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 62 }, - "signature": [ - "Partial & { id: string; }" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/common/types.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-common.SavedObjectEmbeddableInput", "type": "Interface", + "tags": [], "label": "SavedObjectEmbeddableInput", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -9052,101 +10108,112 @@ "text": "EmbeddableInput" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddable", "id": "def-common.SavedObjectEmbeddableInput.savedObjectId", "type": "string", + "tags": [], "label": "savedObjectId", "description": [], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 12 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", - "lineNumber": 11 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "embeddable", "id": "def-common.ViewMode", "type": "Enum", - "label": "ViewMode", "tags": [], + "label": "ViewMode", "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 11 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "embeddable", "id": "def-common.EmbeddableInput", "type": "Type", - "label": "EmbeddableInput", "tags": [], + "label": "EmbeddableInput", "description": [], + "signature": [ + "{ viewMode?: ViewMode | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: SerializableState | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }" + ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 16 }, - "signature": [ - "{ viewMode?: ViewMode | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: SerializableState | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-common.EmbeddablePersistableStateService", "type": "Type", - "label": "EmbeddablePersistableStateService", "tags": [], + "label": "EmbeddablePersistableStateService", "description": [], + "signature": [ + "PersistableStateService" + ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 67 }, - "signature": [ - "PersistableStateService" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-common.EmbeddableStateWithType", "type": "Type", - "label": "EmbeddableStateWithType", "tags": [], + "label": "EmbeddableStateWithType", "description": [], + "signature": [ + "EmbeddableInput & { type: string; }" + ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 65 }, - "signature": [ - "EmbeddableInput & { type: string; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "embeddable", "id": "def-common.baseEmbeddableMigrations", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "baseEmbeddableMigrations", + "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 31 }, + "deprecated": false, + "children": [], "initialIsOpen": false } ] diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index 9882116372b04..eafc8543b7ce1 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -42,6 +42,9 @@ import embeddableObj from './embeddable.json'; ### Setup +### Start + + ### Interfaces diff --git a/api_docs/embeddable_enhanced.json b/api_docs/embeddable_enhanced.json index 93aeac4994739..5edce68bbb31f 100644 --- a/api_docs/embeddable_enhanced.json +++ b/api_docs/embeddable_enhanced.json @@ -4,24 +4,12 @@ "classes": [], "functions": [ { + "parentPluginId": "embeddableEnhanced", "id": "def-public.isEnhancedEmbeddable", "type": "Function", - "children": [ - { - "id": "def-public.isEnhancedEmbeddable.$1", - "type": "Uncategorized", - "label": "maybeEnhancedEmbeddable", - "isRequired": true, - "signature": [ - "E" - ], - "description": [], - "source": { - "path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts", - "lineNumber": 12 - } - } - ], + "tags": [], + "label": "isEnhancedEmbeddable", + "description": [], "signature": [ "(maybeEnhancedEmbeddable: E) => maybeEnhancedEmbeddable is ", { @@ -57,35 +45,55 @@ }, "> ? E : never>" ], - "description": [], - "label": "isEnhancedEmbeddable", "source": { "path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts", "lineNumber": 11 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddableEnhanced", + "id": "def-public.isEnhancedEmbeddable.$1", + "type": "Uncategorized", + "tags": [], + "label": "maybeEnhancedEmbeddable", + "description": [], + "signature": [ + "E" + ], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts", + "lineNumber": 12 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "embeddableEnhanced", "id": "def-public.EnhancedEmbeddableContext", "type": "Interface", + "tags": [], "label": "EnhancedEmbeddableContext", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddableEnhanced", "id": "def-public.EnhancedEmbeddableContext.embeddable", "type": "CompoundType", + "tags": [], "label": "embeddable", "description": [], - "source": { - "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", - "lineNumber": 21 - }, "signature": [ { "pluginId": "embeddableEnhanced", @@ -119,32 +127,36 @@ "text": "EmbeddableOutput" }, ">>" - ] + ], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", + "lineNumber": 21 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddableEnhanced", "id": "def-public.SetupDependencies", "type": "Interface", + "tags": [], "label": "SetupDependencies", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddableEnhanced", "id": "def-public.SetupDependencies.embeddable", "type": "Object", + "tags": [], "label": "embeddable", "description": [], - "source": { - "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 36 - }, "signature": [ { "pluginId": "embeddable", @@ -153,18 +165,20 @@ "section": "def-public.EmbeddableSetup", "text": "EmbeddableSetup" } - ] + ], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 35 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddableEnhanced", "id": "def-public.SetupDependencies.uiActionsEnhanced", "type": "Object", + "tags": [], "label": "uiActionsEnhanced", "description": [], - "source": { - "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 37 - }, "signature": [ { "pluginId": "uiActionsEnhanced", @@ -173,32 +187,36 @@ "section": "def-public.SetupContract", "text": "SetupContract" } - ] + ], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 36 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddableEnhanced", "id": "def-public.StartDependencies", "type": "Interface", + "tags": [], "label": "StartDependencies", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "embeddableEnhanced", "id": "def-public.StartDependencies.embeddable", "type": "Object", + "tags": [], "label": "embeddable", "description": [], - "source": { - "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 41 - }, "signature": [ { "pluginId": "embeddable", @@ -207,18 +225,20 @@ "section": "def-public.EmbeddableStart", "text": "EmbeddableStart" } - ] + ], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 40 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddableEnhanced", "id": "def-public.StartDependencies.uiActionsEnhanced", "type": "Object", + "tags": [], "label": "uiActionsEnhanced", "description": [], - "source": { - "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 42 - }, "signature": [ { "pluginId": "uiActionsEnhanced", @@ -227,28 +247,26 @@ "section": "def-public.StartContract", "text": "StartContract" } - ] + ], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 41 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 40 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "embeddableEnhanced", "id": "def-public.drilldownGrouping", "type": "Array", + "tags": [], "label": "drilldownGrouping", "description": [], - "source": { - "path": "x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts", - "lineNumber": 12 - }, "signature": [ { "pluginId": "uiActions", @@ -283,50 +301,61 @@ }, "> | undefined; }>" ], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts", + "lineNumber": 12 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "embeddableEnhanced", "id": "def-public.EnhancedEmbeddable", "type": "Type", - "label": "EnhancedEmbeddable", "tags": [], + "label": "EnhancedEmbeddable", "description": [], + "signature": [ + "E & { enhancements: { dynamicActions: DynamicActionManager;}; }" + ], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", "lineNumber": 11 }, - "signature": [ - "E & { enhancements: { dynamicActions: DynamicActionManager;}; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "embeddableEnhanced", "id": "def-public.SetupContract", "type": "Interface", + "tags": [], "label": "SetupContract", "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 46 + "lineNumber": 45 }, + "deprecated": false, + "children": [], "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "embeddableEnhanced", "id": "def-public.StartContract", "type": "Interface", + "tags": [], "label": "StartContract", "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 49 + "lineNumber": 48 }, + "deprecated": false, + "children": [], "lifecycle": "start", "initialIsOpen": true } diff --git a/api_docs/encrypted_saved_objects.json b/api_docs/encrypted_saved_objects.json index 9487ccee9f32d..82e9d314075b4 100644 --- a/api_docs/encrypted_saved_objects.json +++ b/api_docs/encrypted_saved_objects.json @@ -11,6 +11,7 @@ "server": { "classes": [ { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptionError", "type": "Class", "tags": [], @@ -26,123 +27,143 @@ }, " extends Error" ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptionError.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptionError.Unnamed.$1", "type": "string", + "tags": [], "label": "message", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptionError.Unnamed.$2", "type": "string", + "tags": [], "label": "attributeName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptionError.Unnamed.$3", "type": "Enum", + "tags": [], "label": "operation", - "isRequired": true, + "description": [], "signature": [ "EncryptionErrorOperation" ], - "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptionError.Unnamed.$4", "type": "Object", + "tags": [], "label": "cause", - "isRequired": false, + "description": [], "signature": [ "Error | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", - "lineNumber": 17 - } + "returnComment": [] }, { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptionError.toJSON", "type": "Function", + "tags": [], "label": "toJSON", + "description": [], "signature": [ "() => { message: string; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", - "lineNumber": 16 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectsClient", "type": "Interface", + "tags": [], "label": "EncryptedSavedObjectsClient", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser", "type": "Function", + "tags": [], "label": "getDecryptedAsInternalUser", "description": [], - "source": { - "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", - "lineNumber": 41 - }, "signature": [ "(type: string, id: string, options?: ", { @@ -155,70 +176,79 @@ " | undefined) => Promise<", "SavedObject", ">" - ] + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "lineNumber": 41 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", - "lineNumber": 40 - }, "initialIsOpen": false }, { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectTypeRegistration", "type": "Interface", + "tags": [], "label": "EncryptedSavedObjectTypeRegistration", "description": [ "\nDescribes the registration entry for the saved object type that contain attributes that need to\nbe encrypted." ], - "tags": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectTypeRegistration.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", "lineNumber": 34 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToEncrypt", "type": "Object", + "tags": [], "label": "attributesToEncrypt", "description": [], - "source": { - "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", - "lineNumber": 35 - }, "signature": [ "ReadonlySet" - ] + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", + "lineNumber": 35 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToExcludeFromAAD", "type": "Object", + "tags": [], "label": "attributesToExcludeFromAAD", "description": [], + "signature": [ + "ReadonlySet | undefined" + ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", "lineNumber": 36 }, - "signature": [ - "ReadonlySet | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", - "lineNumber": 33 - }, "initialIsOpen": false } ], @@ -226,16 +256,23 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectsPluginSetup", "type": "Interface", + "tags": [], "label": "EncryptedSavedObjectsPluginSetup", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectsPluginSetup.canEncrypt", "type": "boolean", + "tags": [], "label": "canEncrypt", "description": [ "\nIndicates if Saved Object encryption is possible. Requires an encryption key to be explicitly set via `xpack.encryptedSavedObjects.encryptionKey`." @@ -243,18 +280,16 @@ "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 35 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectsPluginSetup.registerType", "type": "Function", + "tags": [], "label": "registerType", "description": [], - "source": { - "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", - "lineNumber": 36 - }, "signature": [ "(typeRegistration: ", { @@ -265,70 +300,79 @@ "text": "EncryptedSavedObjectTypeRegistration" }, ") => void" - ] + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 36 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectsPluginSetup.createMigration", "type": "Function", + "tags": [], "label": "createMigration", "description": [], + "signature": [ + "CreateEncryptedSavedObjectsMigrationFn" + ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 37 }, - "signature": [ - "CreateEncryptedSavedObjectsMigrationFn" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", - "lineNumber": 31 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectsPluginStart", "type": "Interface", + "tags": [], "label": "EncryptedSavedObjectsPluginStart", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError", "type": "Function", + "tags": [], "label": "isEncryptionError", "description": [], + "signature": [ + "(error: Error) => boolean" + ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 41 }, - "signature": [ - "(error: Error) => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "encryptedSavedObjects", "id": "def-server.EncryptedSavedObjectsPluginStart.getClient", "type": "Function", + "tags": [], "label": "getClient", "description": [], + "signature": [ + "ClientInstanciator" + ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 42 }, - "signature": [ - "ClientInstanciator" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", - "lineNumber": 40 - }, "lifecycle": "start", "initialIsOpen": true } diff --git a/api_docs/enterprise_search.json b/api_docs/enterprise_search.json index 83b5fc5c1bc1e..4af411b53634c 100644 --- a/api_docs/enterprise_search.json +++ b/api_docs/enterprise_search.json @@ -15,32 +15,31 @@ "enums": [], "misc": [ { + "parentPluginId": "enterpriseSearch", "id": "def-server.ConfigType", "type": "Type", - "label": "ConfigType", "tags": [], + "label": "ConfigType", "description": [], + "signature": [ + "{ readonly host?: string | undefined; readonly enabled: boolean; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }" + ], "source": { "path": "x-pack/plugins/enterprise_search/server/index.ts", "lineNumber": 24 }, - "signature": [ - "{ readonly host?: string | undefined; readonly enabled: boolean; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [], + "parentPluginId": "enterpriseSearch", "id": "def-server.configSchema", "type": "Object", + "tags": [], "label": "configSchema", "description": [], - "source": { - "path": "x-pack/plugins/enterprise_search/server/index.ts", - "lineNumber": 17 - }, "signature": [ "ObjectType", "<{ host: ", @@ -52,6 +51,11 @@ "; accessCheckTimeoutWarning: ", "Type" ], + "source": { + "path": "x-pack/plugins/enterprise_search/server/index.ts", + "lineNumber": 17 + }, + "deprecated": false, "initialIsOpen": false } ] diff --git a/api_docs/es_ui_shared.json b/api_docs/es_ui_shared.json index ac32be544759c..55ede83e42dc1 100644 --- a/api_docs/es_ui_shared.json +++ b/api_docs/es_ui_shared.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "esUiShared", "id": "def-public.CronEditor", "type": "Class", "tags": [], @@ -20,11 +21,19 @@ "FieldToValueMap", ", any>" ], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.CronEditor.getDerivedStateFromProps", "type": "Function", + "tags": [], "label": "getDerivedStateFromProps", + "description": [], "signature": [ "typeof ", { @@ -36,70 +45,99 @@ }, ".getDerivedStateFromProps" ], - "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.CronEditor.getDerivedStateFromProps.$1", "type": "Object", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 65 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", - "lineNumber": 65 - } + "returnComment": [] }, { + "parentPluginId": "esUiShared", "id": "def-public.CronEditor.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.CronEditor.Unnamed.$1", "type": "Object", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 70 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", - "lineNumber": 70 - } + "returnComment": [] }, { + "parentPluginId": "esUiShared", "id": "def-public.CronEditor.onChangeFrequency", "type": "Function", + "tags": [], + "label": "onChangeFrequency", + "description": [], + "signature": [ + "(frequency: ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.Frequency", + "text": "Frequency" + }, + ") => void" + ], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.CronEditor.onChangeFrequency.$1", "type": "CompoundType", + "tags": [], "label": "frequency", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "esUiShared", @@ -109,325 +147,383 @@ "text": "Frequency" } ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 80 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "esUiShared", + "id": "def-public.CronEditor.onChangeFields", + "type": "Function", + "tags": [], + "label": "onChangeFields", + "description": [], "signature": [ - "(frequency: ", - { - "pluginId": "esUiShared", - "scope": "public", - "docId": "kibEsUiSharedPluginApi", - "section": "def-public.Frequency", - "text": "Frequency" - }, + "(fields: ", + "FieldToValueMap", ") => void" ], - "description": [], - "label": "onChangeFrequency", "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", - "lineNumber": 80 + "lineNumber": 104 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.CronEditor.onChangeFields", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.CronEditor.onChangeFields.$1", "type": "Object", + "tags": [], "label": "fields", - "isRequired": true, + "description": [], "signature": [ "FieldToValueMap" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 104 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(fields: ", - "FieldToValueMap", - ") => void" - ], - "description": [], - "label": "onChangeFields", - "source": { - "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", - "lineNumber": 104 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "esUiShared", "id": "def-public.CronEditor.renderForm", "type": "Function", + "tags": [], "label": "renderForm", + "description": [], "signature": [ "() => JSX.Element | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 140 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "esUiShared", "id": "def-public.CronEditor.render", "type": "Function", + "tags": [], "label": "render", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 215 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", - "lineNumber": 64 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "esUiShared", "id": "def-public.attemptToURIDecode", "type": "Function", + "tags": [], + "label": "attemptToURIDecode", + "description": [], + "signature": [ + "(value?: string | undefined) => string | undefined" + ], + "source": { + "path": "src/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.attemptToURIDecode.$1", "type": "string", + "tags": [], "label": "value", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(value?: string | undefined) => string | undefined" - ], - "description": [], - "label": "attemptToURIDecode", - "source": { - "path": "src/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts", - "lineNumber": 15 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.AuthorizationProvider", "type": "Function", + "tags": [], + "label": "AuthorizationProvider", + "description": [], + "signature": [ + "({ privilegesEndpoint, httpClient, children }: Props) => JSX.Element" + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.AuthorizationProvider.$1", "type": "Object", + "tags": [], "label": "{ privilegesEndpoint, httpClient, children }", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ privilegesEndpoint, httpClient, children }: Props) => JSX.Element" - ], - "description": [], - "label": "AuthorizationProvider", - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", - "lineNumber": 49 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.extractQueryParams", "type": "Function", + "tags": [], "label": "extractQueryParams", + "description": [], "signature": [ "(queryString: string) => ", "ParsedQuery", "" ], - "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/url/extract_query_params.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.extractQueryParams.$1", "type": "string", + "tags": [], "label": "queryString", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/url/extract_query_params.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/es_ui_shared/public/url/extract_query_params.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.JsonEditor", "type": "Function", + "tags": [], "label": "JsonEditor", "description": [], + "signature": [ + "typeof JsonEditorComp" + ], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx", "lineNumber": 102 }, - "signature": [ - "typeof JsonEditorComp" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.NotAuthorizedSection", "type": "Function", + "tags": [], + "label": "NotAuthorizedSection", + "description": [], + "signature": [ + "({ title, message }: Props) => JSX.Element" + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.NotAuthorizedSection.$1", "type": "Object", + "tags": [], "label": "{ title, message }", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ title, message }: Props) => JSX.Element" - ], - "description": [], - "label": "NotAuthorizedSection", - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx", - "lineNumber": 17 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.SectionError", "type": "Function", + "tags": [], + "label": "SectionError", + "description": [], + "signature": [ + "({ title, error, actions, ...rest }: React.PropsWithChildren) => JSX.Element" + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.SectionError.$1", "type": "CompoundType", + "tags": [], "label": "{\n title,\n error,\n actions,\n ...rest\n}", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ title, error, actions, ...rest }: React.PropsWithChildren) => JSX.Element" - ], - "description": [], - "label": "SectionError", - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", - "lineNumber": 24 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.SectionLoading", "type": "Function", + "tags": [], + "label": "SectionLoading", + "description": [], + "signature": [ + "({ inline, children, ...rest }: React.PropsWithChildren) => JSX.Element" + ], + "source": { + "path": "src/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.SectionLoading.$1", "type": "CompoundType", + "tags": [], "label": "{ inline, children, ...rest }", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ inline, children, ...rest }: React.PropsWithChildren) => JSX.Element" - ], - "description": [], - "label": "SectionLoading", - "source": { - "path": "src/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx", - "lineNumber": 26 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.sendRequest", "type": "Function", + "tags": [], + "label": "sendRequest", + "description": [], + "signature": [ + "(httpClient: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + ", { path, method, body, query, asSystemRequest }: ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.SendRequestConfig", + "text": "SendRequestConfig" + }, + ") => Promise<", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.SendRequestResponse", + "text": "SendRequestResponse" + }, + ">" + ], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.sendRequest.$1", "type": "Object", + "tags": [], "label": "httpClient", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -437,17 +533,20 @@ "text": "HttpSetup" } ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "esUiShared", "id": "def-public.sendRequest.$2", "type": "Object", + "tags": [], "label": "{ path, method, body, query, asSystemRequest }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "esUiShared", @@ -457,15 +556,45 @@ "text": "SendRequestConfig" } ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "esUiShared", + "id": "def-public.useAuthorizationContext", + "type": "Function", + "tags": [], + "label": "useAuthorizationContext", + "description": [], "signature": [ - "(httpClient: ", + "() => Authorization" + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", + "lineNumber": 35 + }, + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "esUiShared", + "id": "def-public.useRequest", + "type": "Function", + "tags": [], + "label": "useRequest", + "description": [], + "signature": [ + "(httpClient: ", { "pluginId": "core", "scope": "public", @@ -473,60 +602,37 @@ "section": "def-public.HttpSetup", "text": "HttpSetup" }, - ", { path, method, body, query, asSystemRequest }: ", + ", { path, method, query, body, pollIntervalMs, initialData, deserializer }: ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", - "section": "def-public.SendRequestConfig", - "text": "SendRequestConfig" + "section": "def-public.UseRequestConfig", + "text": "UseRequestConfig" }, - ") => Promise<", + ") => ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", - "section": "def-public.SendRequestResponse", - "text": "SendRequestResponse" + "section": "def-public.UseRequestResponse", + "text": "UseRequestResponse" }, - ">" - ], - "description": [], - "label": "sendRequest", - "source": { - "path": "src/plugins/es_ui_shared/public/request/send_request.ts", - "lineNumber": 28 - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.useAuthorizationContext", - "type": "Function", - "children": [], - "signature": [ - "() => Authorization" + "" ], - "description": [], - "label": "useAuthorizationContext", "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", - "lineNumber": 35 + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 28 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.useRequest", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.useRequest.$1", "type": "Object", + "tags": [], "label": "httpClient", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -536,17 +642,20 @@ "text": "HttpSetup" } ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "esUiShared", "id": "def-public.useRequest.$2", "type": "Object", + "tags": [], "label": "{ path, method, query, body, pollIntervalMs, initialData, deserializer }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "esUiShared", @@ -556,141 +665,124 @@ "text": "UseRequestConfig" } ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(httpClient: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, - ", { path, method, query, body, pollIntervalMs, initialData, deserializer }: ", - { - "pluginId": "esUiShared", - "scope": "public", - "docId": "kibEsUiSharedPluginApi", - "section": "def-public.UseRequestConfig", - "text": "UseRequestConfig" - }, - ") => ", - { - "pluginId": "esUiShared", - "scope": "public", - "docId": "kibEsUiSharedPluginApi", - "section": "def-public.UseRequestResponse", - "text": "UseRequestResponse" - }, - "" - ], - "description": [], - "label": "useRequest", - "source": { - "path": "src/plugins/es_ui_shared/public/request/use_request.ts", - "lineNumber": 28 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.WithPrivileges", "type": "Function", + "tags": [], + "label": "WithPrivileges", + "description": [], + "signature": [ + "({ privileges: requiredPrivileges, children }: Props) => JSX.Element" + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.WithPrivileges.$1", "type": "Object", + "tags": [], "label": "{ privileges: requiredPrivileges, children }", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ privileges: requiredPrivileges, children }: Props) => JSX.Element" - ], - "description": [], - "label": "WithPrivileges", - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx", - "lineNumber": 32 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "esUiShared", "id": "def-public.Error", "type": "Interface", + "tags": [], "label": "Error", "description": [], - "tags": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.Error.error", "type": "string", + "tags": [], "label": "error", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.Error.cause", "type": "Array", + "tags": [], "label": "cause", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", "lineNumber": 14 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.Error.message", "type": "string", + "tags": [], "label": "message", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", "lineNumber": 15 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.JsonEditorState", "type": "Interface", + "tags": [], "label": "JsonEditorState", + "description": [], "signature": [ { "pluginId": "esUiShared", @@ -701,116 +793,130 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.JsonEditorState.data", "type": "Object", + "tags": [], "label": "data", "description": [], + "signature": [ + "{ raw: string; format(): T; }" + ], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", "lineNumber": 15 }, - "signature": [ - "{ raw: string; format(): T; }" - ] + "deprecated": false }, { + "parentPluginId": "esUiShared", "id": "def-public.JsonEditorState.validate", "type": "Function", + "tags": [], "label": "validate", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.JsonEditorState.isValid", "type": "CompoundType", + "tags": [], "label": "isValid", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", "lineNumber": 20 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.MissingPrivileges", "type": "Interface", + "tags": [], "label": "MissingPrivileges", "description": [], - "tags": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-public.MissingPrivileges.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 10 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.Privileges", "type": "Interface", + "tags": [], "label": "Privileges", "description": [], - "tags": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.Privileges.hasAllPrivileges", "type": "boolean", + "tags": [], "label": "hasAllPrivileges", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.Privileges.missingPrivileges", "type": "Object", + "tags": [], "label": "missingPrivileges", "description": [], - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", - "lineNumber": 15 - }, "signature": [ { "pluginId": "esUiShared", @@ -819,57 +925,65 @@ "section": "def-common.MissingPrivileges", "text": "MissingPrivileges" } - ] + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 15 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.SendRequestConfig", "type": "Interface", + "tags": [], "label": "SendRequestConfig", "description": [], - "tags": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.SendRequestConfig.path", "type": "string", + "tags": [], "label": "path", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.SendRequestConfig.method", "type": "CompoundType", + "tags": [], "label": "method", "description": [], + "signature": [ + "\"get\" | \"post\" | \"put\" | \"delete\" | \"patch\" | \"head\"" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 13 }, - "signature": [ - "\"get\" | \"post\" | \"put\" | \"delete\" | \"patch\" | \"head\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.SendRequestConfig.query", "type": "Object", + "tags": [], "label": "query", "description": [], - "source": { - "path": "src/plugins/es_ui_shared/public/request/send_request.ts", - "lineNumber": 14 - }, "signature": [ { "pluginId": "core", @@ -879,49 +993,57 @@ "text": "HttpFetchQuery" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 14 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.SendRequestConfig.body", "type": "Any", + "tags": [], "label": "body", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 15 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.SendRequestConfig.asSystemRequest", "type": "CompoundType", + "tags": [], "label": "asSystemRequest", "description": [ "\nIf set, flags this as a \"system request\" to indicate that this is not a user-initiated request. For more information, see\nHttpFetchOptions#asSystemRequest." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 20 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/es_ui_shared/public/request/send_request.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.SendRequestResponse", "type": "Interface", + "tags": [], "label": "SendRequestResponse", + "description": [], "signature": [ { "pluginId": "esUiShared", @@ -932,48 +1054,54 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.SendRequestResponse.data", "type": "CompoundType", + "tags": [], "label": "data", "description": [], + "signature": [ + "D | null" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 24 }, - "signature": [ - "D | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.SendRequestResponse.error", "type": "CompoundType", + "tags": [], "label": "error", "description": [], + "signature": [ + "E | null" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 25 }, - "signature": [ - "E | null" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/es_ui_shared/public/request/send_request.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.UseRequestConfig", "type": "Interface", + "tags": [], "label": "UseRequestConfig", + "description": [], "signature": [ { "pluginId": "esUiShared", @@ -991,62 +1119,70 @@ "text": "SendRequestConfig" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.UseRequestConfig.pollIntervalMs", "type": "number", + "tags": [], "label": "pollIntervalMs", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 15 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.UseRequestConfig.initialData", "type": "Any", + "tags": [], "label": "initialData", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 16 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.UseRequestConfig.deserializer", "type": "Function", + "tags": [], "label": "deserializer", "description": [], + "signature": [ + "((data: any) => any) | undefined" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 17 }, - "signature": [ - "((data: any) => any) | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/es_ui_shared/public/request/use_request.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.UseRequestResponse", "type": "Interface", + "tags": [], "label": "UseRequestResponse", + "description": [], "signature": [ { "pluginId": "esUiShared", @@ -1057,108 +1193,116 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.UseRequestResponse.isInitialRequest", "type": "boolean", + "tags": [], "label": "isInitialRequest", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.UseRequestResponse.isLoading", "type": "boolean", + "tags": [], "label": "isLoading", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.UseRequestResponse.error", "type": "CompoundType", + "tags": [], "label": "error", "description": [], + "signature": [ + "E | null" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 23 }, - "signature": [ - "E | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.UseRequestResponse.data", "type": "CompoundType", + "tags": [], "label": "data", "description": [], + "signature": [ + "D | null | undefined" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 24 }, - "signature": [ - "D | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.UseRequestResponse.resendRequest", "type": "Function", + "tags": [], "label": "resendRequest", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 25 }, - "signature": [ - "() => void" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/es_ui_shared/public/request/use_request.ts", - "lineNumber": 20 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "esUiShared", "id": "def-public.Frequency", "type": "Type", - "label": "Frequency", "tags": [], + "label": "Frequency", "description": [], + "signature": [ + "\"MINUTE\" | \"HOUR\" | \"DAY\" | \"WEEK\" | \"MONTH\" | \"YEAR\"" + ], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/types.ts", "lineNumber": 9 }, - "signature": [ - "\"MINUTE\" | \"HOUR\" | \"DAY\" | \"WEEK\" | \"MONTH\" | \"YEAR\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.OnJsonEditorUpdateHandler", "type": "Type", - "label": "OnJsonEditorUpdateHandler", "tags": [], + "label": "OnJsonEditorUpdateHandler", "description": [], - "source": { - "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", - "lineNumber": 23 - }, "signature": [ "(arg: ", { @@ -1170,96 +1314,113 @@ }, ") => void" ], + "source": { + "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", + "lineNumber": 23 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.AuthorizationContext", "type": "Object", + "tags": [], "label": "AuthorizationContext", "description": [], + "signature": [ + "React.Context" + ], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", "lineNumber": 33 }, - "signature": [ - "React.Context" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-public.indices", "type": "Object", "tags": [], + "label": "indices", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/indices/index.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.indices.INDEX_ILLEGAL_CHARACTERS_VISIBLE", "type": "Array", + "tags": [], "label": "INDEX_ILLEGAL_CHARACTERS_VISIBLE", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 18 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.indices.indexNameBeginsWithPeriod", "type": "Function", + "tags": [], "label": "indexNameBeginsWithPeriod", "description": [], + "signature": [ + "typeof ", + "indexNameBeginsWithPeriod" + ], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 19 }, - "signature": [ - "typeof ", - "indexNameBeginsWithPeriod" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.indices.findIllegalCharactersInIndexName", "type": "Function", + "tags": [], "label": "findIllegalCharactersInIndexName", "description": [], + "signature": [ + "typeof ", + "findIllegalCharactersInIndexName" + ], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 20 }, - "signature": [ - "typeof ", - "findIllegalCharactersInIndexName" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-public.indices.indexNameContainsSpaces", "type": "Function", + "tags": [], "label": "indexNameContainsSpaces", "description": [], + "signature": [ + "typeof ", + "indexNameContainsSpaces" + ], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 21 }, - "signature": [ - "typeof ", - "indexNameContainsSpaces" - ] + "deprecated": false } ], - "description": [], - "label": "indices", - "source": { - "path": "src/plugins/es_ui_shared/public/indices/index.ts", - "lineNumber": 17 - }, "initialIsOpen": false } ] @@ -1268,23 +1429,15 @@ "classes": [], "functions": [ { + "parentPluginId": "esUiShared", "id": "def-server.handleEsError", "type": "Function", - "children": [ - { - "id": "def-server.handleEsError.$1", - "type": "Object", - "label": "{\n error,\n response,\n handleCustomError,\n}", - "isRequired": true, - "signature": [ - "EsErrorHandlerParams" - ], - "description": [], - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", - "lineNumber": 23 - } - } + "tags": [ + "throws" + ], + "label": "handleEsError", + "description": [ + "\nFor errors returned by the new elasticsearch js client.\n" ], "signature": [ "({ error, response, handleCustomError, }: EsErrorHandlerParams) => ", @@ -1297,77 +1450,104 @@ }, "" ], - "description": [], - "label": "handleEsError", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", - "lineNumber": 23 + "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "esUiShared", + "id": "def-server.handleEsError.$1", + "type": "Object", + "tags": [], + "label": "{\n error,\n response,\n handleCustomError,\n}", + "description": [], + "signature": [ + "EsErrorHandlerParams" + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", + "lineNumber": 25 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-server.isEsError", "type": "Function", + "tags": [], "label": "isEsError", + "description": [], "signature": [ "(err: RequestError) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-server.isEsError.$1", "type": "Object", + "tags": [], "label": "err", - "isRequired": true, + "description": [], "signature": [ "RequestError" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-server.parseEsError", "type": "Function", + "tags": [], + "label": "parseEsError", + "description": [], + "signature": [ + "(err: string) => ParsedError" + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-server.parseEsError.$1", "type": "string", + "tags": [], "label": "err", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(err: string) => ParsedError" - ], - "description": [], - "label": "parseEsError", - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts", - "lineNumber": 27 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } @@ -1382,61 +1562,70 @@ "functions": [], "interfaces": [ { + "parentPluginId": "esUiShared", "id": "def-common.MissingPrivileges", "type": "Interface", + "tags": [], "label": "MissingPrivileges", "description": [], - "tags": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "esUiShared", "id": "def-common.MissingPrivileges.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 10 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "esUiShared", "id": "def-common.Privileges", "type": "Interface", + "tags": [], "label": "Privileges", "description": [], - "tags": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-common.Privileges.hasAllPrivileges", "type": "boolean", + "tags": [], "label": "hasAllPrivileges", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "esUiShared", "id": "def-common.Privileges.missingPrivileges", "type": "Object", + "tags": [], "label": "missingPrivileges", "description": [], - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", - "lineNumber": 15 - }, "signature": [ { "pluginId": "esUiShared", @@ -1445,13 +1634,14 @@ "section": "def-common.MissingPrivileges", "text": "MissingPrivileges" } - ] + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 15 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", - "lineNumber": 13 - }, "initialIsOpen": false } ], diff --git a/api_docs/event_log.json b/api_docs/event_log.json index 5523b3eb60b4b..74175ad318761 100644 --- a/api_docs/event_log.json +++ b/api_docs/event_log.json @@ -11,6 +11,7 @@ "server": { "classes": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter", "type": "Class", "tags": [], @@ -26,348 +27,412 @@ }, "" ], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.Unnamed.$1", "type": "Object", + "tags": [], "label": "opts", - "isRequired": true, + "description": [], "signature": [ "ConstructorOpts" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 54 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.shutdown", "type": "Function", + "tags": [], "label": "shutdown", + "description": [], "signature": [ "() => Promise" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 78 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.indexDocument", "type": "Function", + "tags": [], "label": "indexDocument", + "description": [], "signature": [ "(doc: TDoc) => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.indexDocument.$1", "type": "Uncategorized", + "tags": [], "label": "doc", - "isRequired": true, + "description": [], "signature": [ "TDoc" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 83 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.indexDocuments", "type": "Function", + "tags": [], "label": "indexDocuments", + "description": [], "signature": [ "(docs: TDoc[]) => Promise" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 87 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.indexDocuments.$1", "type": "Array", + "tags": [], "label": "docs", - "isRequired": true, + "description": [], "signature": [ "TDoc[]" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 87 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 87 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.doesIlmPolicyExist", "type": "Function", + "tags": [], "label": "doesIlmPolicyExist", + "description": [], "signature": [ "(policyName: string) => Promise" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 123 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.doesIlmPolicyExist.$1", "type": "string", + "tags": [], "label": "policyName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 123 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 123 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.createIlmPolicy", "type": "Function", + "tags": [], "label": "createIlmPolicy", + "description": [], "signature": [ "(policyName: string, policy: Record) => Promise" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 138 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.createIlmPolicy.$1", "type": "string", + "tags": [], "label": "policyName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.createIlmPolicy.$2", "type": "Object", + "tags": [], "label": "policy", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 138 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 138 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.doesIndexTemplateExist", "type": "Function", + "tags": [], "label": "doesIndexTemplateExist", + "description": [], "signature": [ "(name: string) => Promise" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 152 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.doesIndexTemplateExist.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 152 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 152 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.createIndexTemplate", "type": "Function", + "tags": [], "label": "createIndexTemplate", + "description": [], "signature": [ "(name: string, template: Record) => Promise" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 162 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.createIndexTemplate.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 162 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.createIndexTemplate.$2", "type": "Object", + "tags": [], "label": "template", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 162 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 162 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.doesAliasExist", "type": "Function", + "tags": [], "label": "doesAliasExist", + "description": [], "signature": [ "(name: string) => Promise" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 180 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.doesAliasExist.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 180 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 180 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.createIndex", "type": "Function", + "tags": [], "label": "createIndex", + "description": [], "signature": [ "(name: string, body?: Record) => Promise" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 190 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.createIndex.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 190 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.createIndex.$2", "type": "Object", + "tags": [], "label": "body", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 190 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 190 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects", "type": "Function", + "tags": [], "label": "queryEventsBySavedObjects", + "description": [], "signature": [ "(index: string, namespace: string | undefined, type: string, ids: string[], { page, per_page: perPage, start, end, sort_field, sort_order, filter }: ", "FindOptionsType", @@ -381,127 +446,148 @@ }, ">" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 204 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects.$1", "type": "string", + "tags": [], "label": "index", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 205 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects.$2", "type": "string", + "tags": [], "label": "namespace", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 206 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects.$3", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 207 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects.$4", "type": "Array", + "tags": [], "label": "ids", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 208 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects.$5", "type": "CompoundType", + "tags": [], "label": "{ page, per_page: perPage, start, end, sort_field, sort_order, filter }", - "isRequired": true, + "description": [], "signature": [ "FindOptionsType" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 210 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 204 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 47 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "eventLog", "id": "def-server.createReadySignal", "type": "Function", + "tags": [], "label": "createReadySignal", + "description": [], "signature": [ "() => ", "ReadySignal", "" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/event_log/server/lib/ready_signal.ts", "lineNumber": 13 }, + "deprecated": false, + "children": [], + "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogClient", "type": "Interface", + "tags": [], "label": "IEventLogClient", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogClient.findEventsBySavedObjectIds", "type": "Function", + "tags": [], "label": "findEventsBySavedObjectIds", + "description": [], "signature": [ "(type: string, ids: string[], options?: Partial<", "FindOptionsType", @@ -515,497 +601,575 @@ }, ">" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogClient.findEventsBySavedObjectIds.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogClient.findEventsBySavedObjectIds.$2", "type": "Array", + "tags": [], "label": "ids", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogClient.findEventsBySavedObjectIds.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ "Partial<", "FindOptionsType", "> | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 48 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 45 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogger", "type": "Interface", + "tags": [], "label": "IEventLogger", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 52 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogger.logEvent", "type": "Function", + "tags": [], "label": "logEvent", + "description": [], "signature": [ "(properties: DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogger.logEvent.$1", "type": "Object", + "tags": [], "label": "properties", - "isRequired": false, + "description": [], "signature": [ "DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 53 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogger.startTiming", "type": "Function", + "tags": [], "label": "startTiming", + "description": [], "signature": [ "(event: DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogger.startTiming.$1", "type": "Object", + "tags": [], "label": "event", - "isRequired": false, + "description": [], "signature": [ "DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 54 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogger.stopTiming", "type": "Function", + "tags": [], "label": "stopTiming", + "description": [], "signature": [ "(event: DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogger.stopTiming.$1", "type": "Object", + "tags": [], "label": "event", - "isRequired": false, + "description": [], "signature": [ "DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 55 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 52 - }, "initialIsOpen": false }, { + "parentPluginId": "eventLog", "id": "def-server.QueryEventsBySavedObjectResult", "type": "Interface", + "tags": [], "label": "QueryEventsBySavedObjectResult", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "eventLog", "id": "def-server.QueryEventsBySavedObjectResult.page", "type": "number", + "tags": [], "label": "page", "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 38 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "eventLog", "id": "def-server.QueryEventsBySavedObjectResult.per_page", "type": "number", + "tags": [], "label": "per_page", "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 39 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "eventLog", "id": "def-server.QueryEventsBySavedObjectResult.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 40 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "eventLog", "id": "def-server.QueryEventsBySavedObjectResult.data", "type": "Array", + "tags": [], "label": "data", "description": [], + "signature": [ + "(Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]" + ], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "lineNumber": 41 }, - "signature": [ - "(Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 37 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "eventLog", "id": "def-server.IEvent", "type": "Type", - "label": "IEvent", "tags": [], + "label": "IEvent", "description": [], + "signature": [ + "undefined | DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>>" + ], "source": { "path": "x-pack/plugins/event_log/generated/schemas.ts", "lineNumber": 26 }, - "signature": [ - "undefined | DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "eventLog", "id": "def-server.IValidatedEvent", "type": "Type", - "label": "IValidatedEvent", "tags": [], + "label": "IValidatedEvent", "description": [], + "signature": [ + "undefined | Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>" + ], "source": { "path": "x-pack/plugins/event_log/generated/schemas.ts", "lineNumber": 25 }, - "signature": [ - "undefined | Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "eventLog", "id": "def-server.SAVED_OBJECT_REL_PRIMARY", "type": "string", + "tags": [], "label": "SAVED_OBJECT_REL_PRIMARY", "description": [], + "signature": [ + "\"primary\"" + ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 18 }, - "signature": [ - "\"primary\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService", "type": "Interface", + "tags": [], "label": "IEventLogService", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.isEnabled", "type": "Function", + "tags": [], "label": "isEnabled", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.isLoggingEntries", "type": "Function", + "tags": [], "label": "isLoggingEntries", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.isIndexingEntries", "type": "Function", + "tags": [], "label": "isIndexingEntries", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.registerProviderActions", "type": "Function", + "tags": [], "label": "registerProviderActions", + "description": [], "signature": [ "(provider: string, actions: string[]) => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.registerProviderActions.$1", "type": "string", + "tags": [], "label": "provider", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.registerProviderActions.$2", "type": "Array", + "tags": [], "label": "actions", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 33 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.isProviderActionRegistered", "type": "Function", + "tags": [], "label": "isProviderActionRegistered", + "description": [], "signature": [ "(provider: string, action: string) => boolean" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.isProviderActionRegistered.$1", "type": "string", + "tags": [], "label": "provider", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.isProviderActionRegistered.$2", "type": "string", + "tags": [], "label": "action", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 34 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.getProviderActions", "type": "Function", + "tags": [], "label": "getProviderActions", + "description": [], "signature": [ "() => Map>" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.registerSavedObjectProvider", "type": "Function", + "tags": [], "label": "registerSavedObjectProvider", + "description": [], "signature": [ "(type: string, provider: ", "SavedObjectProvider", ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.registerSavedObjectProvider.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.registerSavedObjectProvider.$2", "type": "Function", + "tags": [], "label": "provider", - "isRequired": true, + "description": [], "signature": [ "SavedObjectProvider" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 36 - } + "returnComment": [] }, { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.getLogger", "type": "Function", + "tags": [], "label": "getLogger", + "description": [], "signature": [ "(properties: DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ", { @@ -1016,49 +1180,56 @@ "text": "IEventLogger" } ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogService.getLogger.$1", "type": "Object", + "tags": [], "label": "properties", - "isRequired": false, + "description": [], "signature": [ "DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 37 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 37 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 29 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "eventLog", "id": "def-server.IEventLogClientService", "type": "Interface", + "tags": [], "label": "IEventLogClientService", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogClientService.getClient", "type": "Function", + "tags": [], "label": "getClient", + "description": [], "signature": [ "(request: ", { @@ -1077,13 +1248,19 @@ "text": "IEventLogClient" } ], - "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "eventLog", "id": "def-server.IEventLogClientService.getClient.$1", "type": "Object", + "tags": [], "label": "request", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1094,25 +1271,17 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/event_log/server/types.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 41 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/event_log/server/types.ts", - "lineNumber": 40 - }, "lifecycle": "start", "initialIsOpen": true } @@ -1124,18 +1293,20 @@ "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "eventLog", "id": "def-common.BASE_EVENT_LOG_API_PATH", "type": "string", + "tags": [], "label": "BASE_EVENT_LOG_API_PATH", "description": [], + "signature": [ + "\"/api/event_log\"" + ], "source": { "path": "x-pack/plugins/event_log/common/index.ts", "lineNumber": 8 }, - "signature": [ - "\"/api/event_log\"" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/expressions.json b/api_docs/expressions.json index 7355d2904e63b..417e4807dc918 100644 --- a/api_docs/expressions.json +++ b/api_docs/expressions.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "expressions", "id": "def-public.Execution", "type": "Class", "tags": [], @@ -18,19 +19,21 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 84 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Execution.state", "type": "Object", + "tags": [], "label": "state", "description": [ "\nDynamic state of the execution." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 80 - }, "signature": [ { "pluginId": "expressions", @@ -64,36 +67,40 @@ "text": "SerializableState" }, " | undefined; }>>" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 94 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Execution.input", "type": "Uncategorized", + "tags": [], "label": "input", "description": [ "\nInitial input of the execution.\n\nN.B. It is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], + "signature": [ + "Input" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 88 + "lineNumber": 102 }, - "signature": [ - "Input" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Execution.context", "type": "Object", + "tags": [], "label": "context", "description": [ "\nExecution context - object that allows to do side-effects. Context is passed\nto every function." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 94 - }, "signature": [ { "pluginId": "expressions", @@ -105,54 +112,25 @@ "" - ] - }, - { - "tags": [], - "id": "def-public.Execution.contract", - "type": "Object", - "label": "contract", - "description": [ - "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 134 + "lineNumber": 113 }, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContract", - "text": "ExecutionContract" - }, - "" - ] - }, - { - "tags": [], - "id": "def-public.Execution.expression", - "type": "string", - "label": "expression", - "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 140 - } + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.Execution.result", "type": "Object", - "label": "result", "tags": [], - "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 142 - }, + "label": "result", + "description": [ + "\nFuture that tracks result or error of this execution." + ], "signature": [ - "Promise>" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 140 + }, + "deprecated": false }, { - "id": "def-public.Execution.inspectorAdapters", - "type": "Uncategorized", - "label": "inspectorAdapters", + "parentPluginId": "expressions", + "id": "def-public.Execution.contract", + "type": "Object", + "tags": [], + "label": "contract", + "description": [ + "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" + }, + "" + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 153 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.Execution.expression", + "type": "string", "tags": [], + "label": "expression", "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 146 + "lineNumber": 159 }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.Execution.inspectorAdapters", + "type": "Uncategorized", + "tags": [], + "label": "inspectorAdapters", + "description": [], "signature": [ "InspectorAdapters" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 161 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.Execution.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 165 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Execution.Unnamed.$1", "type": "Object", + "tags": [], "label": "execution", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -216,75 +248,107 @@ "text": "ExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 - } + "lineNumber": 165 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.cancel", "type": "Function", + "tags": [], "label": "cancel", - "signature": [ - "() => void" - ], "description": [ "\nStop execution of expression." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 192 - } + "lineNumber": 229 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.start", "type": "Function", + "tags": [], "label": "start", - "signature": [ - "(input?: Input) => void" - ], "description": [ "\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], + "signature": [ + "(input?: Input) => ", + "Observable", + ">" + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 239 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Execution.start.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "Input" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 - } + "lineNumber": 239 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.invokeChain", "type": "Function", + "tags": [], "label": "invokeChain", + "description": [], "signature": [ "(chainArr: ", { @@ -294,15 +358,23 @@ "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, - "[], input: unknown) => Promise" + "[], input: unknown) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 263 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Execution.invokeChain.$1", "type": "Array", + "tags": [], "label": "chainArr", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -313,38 +385,40 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 - } + "lineNumber": 263 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Execution.invokeChain.$2", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 - } + "lineNumber": 263 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.invokeFunction", "type": "Function", + "tags": [], "label": "invokeFunction", + "description": [], "signature": [ "(fn: ", { @@ -354,15 +428,23 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, args: Record) => Promise" + ", input: unknown, args: Record) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 336 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Execution.invokeFunction.$1", "type": "Object", + "tags": [], "label": "fn", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -372,97 +454,110 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 317 - } + "lineNumber": 337 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Execution.invokeFunction.$2", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 318 - } + "lineNumber": 338 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Execution.invokeFunction.$3", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 319 - } + "lineNumber": 339 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 316 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.cast", "type": "Function", + "tags": [], "label": "cast", + "description": [], "signature": [ "(value: any, toTypeNames?: string[] | undefined) => any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Execution.cast.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 - } + "lineNumber": 374 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Execution.cast.$2", "type": "Array", + "tags": [], "label": "toTypeNames", - "isRequired": false, + "description": [], "signature": [ "string[] | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 - } + "lineNumber": 374 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.resolveArgs", "type": "Function", + "tags": [], "label": "resolveArgs", + "description": [], "signature": [ "(fnDef: ", { @@ -472,15 +567,23 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, argAsts: any) => Promise" + ", input: unknown, argAsts: any) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 400 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Execution.resolveArgs.$1", "type": "Object", + "tags": [], "label": "fnDef", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -490,52 +593,57 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "lineNumber": 400 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Execution.resolveArgs.$2", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "lineNumber": 400 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Execution.resolveArgs.$3", "type": "Any", + "tags": [], "label": "argAsts", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "lineNumber": 400 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.interpret", "type": "Function", + "tags": [], "label": "interpret", + "description": [], "signature": [ "(ast: ", { @@ -545,15 +653,23 @@ "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" }, - ", input: T) => Promise" + ", input: T) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 489 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Execution.interpret.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -563,42 +679,38 @@ "text": "ExpressionAstNode" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 - } + "lineNumber": 489 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Execution.interpret.$2", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 - } + "lineNumber": 489 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 70 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionContract", "type": "Class", "tags": [], @@ -616,32 +728,48 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExecutionContract.isPending", "type": "boolean", - "label": "isPending", "tags": [], + "label": "isPending", "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 18 - } + "lineNumber": 20 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionContract.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExecutionContract.Unnamed.$1", "type": "Object", + "tags": [], "label": "execution", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -652,42 +780,45 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 24 - } + "lineNumber": 26 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 24 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionContract.cancel", "type": "Function", - "children": [], - "signature": [ - "() => void" - ], + "tags": [], + "label": "cancel", "description": [ "\nCancel the execution of the expression. This will set abort signal\n(available in execution context) to aborted state, letting expression\nfunctions to stop their execution." ], - "label": "cancel", + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 31 + "lineNumber": 33 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionContract.getData", "type": "Function", - "children": [], + "tags": [], + "label": "getData", + "description": [ + "\nReturns the final output of expression, if any error happens still\nwraps that error into `ExpressionValueError` type and returns that.\nThis function never throws." + ], "signature": [ "() => Promise<", { @@ -715,39 +846,43 @@ }, " | undefined; }> | Output>" ], - "description": [ - "\nReturns the final output of expression, if any error happens still\nwraps that error into `ExpressionValueError` type and returns that.\nThis function never throws." - ], - "label": "getData", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 40 + "lineNumber": 42 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionContract.getExpression", "type": "Function", - "children": [], - "signature": [ - "() => string" - ], + "tags": [], + "label": "getExpression", "description": [ "\nGet string representation of the expression. Returns the original string\nif execution was started from a string. If execution was started from an\nAST this method returns a string generated from AST." ], - "label": "getExpression", + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 60 + "lineNumber": 65 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionContract.getAst", "type": "Function", - "children": [], + "tags": [], + "label": "getAst", + "description": [ + "\nGet AST used to execute the expression." + ], "signature": [ "() => ", { @@ -758,43 +893,39 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "\nGet AST used to execute the expression." - ], - "label": "getAst", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 67 + "lineNumber": 72 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionContract.inspect", "type": "Function", - "children": [], - "signature": [ - "() => InspectorAdapters" - ], + "tags": [], + "label": "inspect", "description": [ "\nGet Inspector adapters provided to all functions of expression through\nexecution context." ], - "label": "inspect", + "signature": [ + "() => InspectorAdapters" + ], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 73 + "lineNumber": 78 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.Executor", "type": "Class", "tags": [], @@ -826,11 +957,19 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 81 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.createWithDefaults", "type": "Function", + "tags": [], "label": "createWithDefaults", + "description": [], "signature": [ "typeof ", { @@ -842,13 +981,19 @@ }, ".createWithDefaults" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.createWithDefaults.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "expressions", @@ -859,30 +1004,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 83 - } + "lineNumber": 84 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 82 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Executor.state", "type": "Object", + "tags": [], "label": "state", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 91 - }, "signature": [ { "pluginId": "expressions", @@ -892,20 +1030,22 @@ "text": "ExecutorContainer" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 92 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.Executor.functions", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-public.Executor.functions", - "type": "Object", "label": "functions", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 96 - }, "signature": [ { "pluginId": "expressions", @@ -914,20 +1054,23 @@ "section": "def-common.FunctionsRegistry", "text": "FunctionsRegistry" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 97 + }, + "deprecated": true, + "references": [] }, { + "parentPluginId": "expressions", + "id": "def-public.Executor.types", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-public.Executor.types", - "type": "Object", "label": "types", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 101 - }, "signature": [ { "pluginId": "expressions", @@ -936,22 +1079,37 @@ "section": "def-common.TypesRegistry", "text": "TypesRegistry" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 102 + }, + "deprecated": true, + "references": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.Unnamed.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "expressions", @@ -962,24 +1120,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 - } + "lineNumber": 104 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.registerFunction", "type": "Function", + "tags": [], "label": "registerFunction", + "description": [], "signature": [ "(functionDefinition: ", { @@ -999,13 +1156,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 110 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.registerFunction.$1", "type": "CompoundType", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -1024,24 +1187,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 110 - } + "lineNumber": 111 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 109 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.getFunction", "type": "Function", + "tags": [], "label": "getFunction", + "description": [], "signature": [ "(name: string) => ", { @@ -1053,34 +1215,39 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 119 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.getFunction.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 - } + "lineNumber": 119 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.getFunctions", "type": "Function", + "tags": [], "label": "getFunctions", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 122 - } + "lineNumber": 123 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.registerType", "type": "Function", + "tags": [], "label": "registerType", + "description": [], "signature": [ "(typeDefinition: ", { @@ -1124,13 +1293,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 127 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.registerType.$1", "type": "CompoundType", + "tags": [], "label": "typeDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -1149,24 +1324,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 127 - } + "lineNumber": 128 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 126 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.getType", "type": "Function", + "tags": [], "label": "getType", + "description": [], "signature": [ "(name: string) => ", { @@ -1178,34 +1352,39 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 136 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.getType.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 - } + "lineNumber": 136 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.getTypes", "type": "Function", + "tags": [], "label": "getTypes", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 139 - } + "lineNumber": 140 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.extendContext", "type": "Function", + "tags": [], "label": "extendContext", + "description": [], "signature": [ "(extraContext: Record) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 144 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.extendContext.$1", "type": "Object", + "tags": [], "label": "extraContext", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 - } + "lineNumber": 144 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.context", "type": "Object", - "label": "context", "tags": [], + "label": "context", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 147 + "lineNumber": 148 }, - "signature": [ - "Record" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.Executor.run", "type": "Function", + "tags": [], "label": "run", + "description": [ + "\nExecute expression and return result.\n" + ], "signature": [ "(ast: string | ", { @@ -1292,17 +1482,40 @@ "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, - ") => Promise" - ], - "description": [ - "\nExecute expression and return result.\n" + ") => ", + "Observable", + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"error\", { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + } ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 160 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.run.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [ + "Expression AST or a string representing expression." + ], "signature": [ "string | ", { @@ -1313,35 +1526,39 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "Expression AST or a string representing expression." - ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 160 - } + "lineNumber": 161 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Executor.run.$2", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, - "signature": [ - "Input" - ], "description": [ "Initial input to the first expression function." ], + "signature": [ + "Input" + ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 161 - } + "lineNumber": 162 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Executor.run.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -1351,24 +1568,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 162 - } + "lineNumber": 163 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 159 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.createExecution", "type": "Function", + "tags": [], "label": "createExecution", + "description": [], "signature": [ "(ast: string | ", { @@ -1404,13 +1620,19 @@ }, ">" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 168 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.createExecution.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ "string | ", { @@ -1421,17 +1643,20 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 170 - } + "lineNumber": 169 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Executor.createExecution.$2", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -1441,24 +1666,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 171 - } + "lineNumber": 170 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 169 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.inject", "type": "Function", + "tags": [], "label": "inject", + "description": [], "signature": [ "(ast: ", { @@ -1479,13 +1703,19 @@ "text": "ExpressionAstExpression" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 216 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.inject.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -1495,39 +1725,41 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 - } + "lineNumber": 216 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Executor.inject.$2", "type": "Array", + "tags": [], "label": "references", - "isRequired": true, + "description": [], "signature": [ "SavedObjectReference", "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 - } + "lineNumber": 216 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.extract", "type": "Function", + "tags": [], "label": "extract", + "description": [], "signature": [ "(ast: ", { @@ -1549,13 +1781,19 @@ "SavedObjectReference", "[]; }" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 229 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.extract.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -1565,24 +1803,23 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 - } + "lineNumber": 229 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.telemetry", "type": "Function", + "tags": [], "label": "telemetry", + "description": [], "signature": [ "(ast: ", { @@ -1594,13 +1831,19 @@ }, ", telemetryData: Record) => Record" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 240 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.telemetry.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -1610,38 +1853,40 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 - } + "lineNumber": 240 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Executor.telemetry.$2", "type": "Object", + "tags": [], "label": "telemetryData", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 - } + "lineNumber": 240 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.migrate", "type": "Function", + "tags": [], "label": "migrate", + "description": [], "signature": [ "(ast: ", { @@ -1660,13 +1905,19 @@ "text": "ExpressionAstExpression" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 248 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.Executor.migrate.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -1676,38 +1927,40 @@ "text": "SerializableState" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 - } + "lineNumber": 248 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Executor.migrate.$2", "type": "string", + "tags": [], "label": "version", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 - } + "lineNumber": 248 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.fork", "type": "Function", + "tags": [], "label": "fork", + "description": [], "signature": [ "() => ", { @@ -1719,23 +1972,19 @@ }, "" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 258 - } + "lineNumber": 257 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 80 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction", "type": "Class", "tags": [], @@ -1767,129 +2016,147 @@ }, "[]>>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nName of function" ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 22 - } + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [ "\nAliases that can be used instead of `name`." ], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 27 + "lineNumber": 26 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future." ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 34 - } + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.fn", "type": "Function", + "tags": [], "label": "fn", "description": [ "\nFunction to run function (context, args)" ], + "signature": [ + "(input: any, params: Record, handlers: object) => any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 39 + "lineNumber": 38 }, - "signature": [ - "(input: any, params: Record, handlers: object) => any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nA short help text." ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 44 - } + "lineNumber": 43 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.args", "type": "Object", "tags": [], - "children": [], + "label": "args", "description": [ "\nSpecification of expression function parameters." ], - "label": "args", "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 49 - } + "lineNumber": 48 + }, + "deprecated": false, + "children": [] }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [ "\nType of inputs that this function supports." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 54 + "lineNumber": 53 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.disabled", "type": "boolean", + "tags": [], "label": "disabled", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 56 - } + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.telemetry", "type": "Function", + "tags": [], "label": "telemetry", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 57 - }, "signature": [ "(state: Record, telemetryData: Record) => Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.extract", "type": "Function", + "tags": [], "label": "extract", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 61 - }, "signature": [ "(state: Record; references: ", "SavedObjectReference", "[]; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 60 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.inject", "type": "Function", + "tags": [], "label": "inject", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 64 - }, "signature": [ "(state: Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 63 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.migrations", "type": "Object", + "tags": [], "label": "migrations", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 68 - }, "signature": [ "{ [key: string]: (state: ", { @@ -1994,22 +2267,36 @@ "text": "SerializableState" }, "; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 67 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.Unnamed.$1", "type": "Object", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -2019,204 +2306,237 @@ "text": "AnyExpressionFunctionDefinition" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 72 - } + "lineNumber": 71 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 72 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.accepts", "type": "Function", + "tags": [], + "label": "accepts", + "description": [], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 105 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.accepts.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 107 - } + "lineNumber": 105 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(type: string) => boolean" - ], - "description": [], - "label": "accepts", - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 107 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter", "type": "Class", "tags": [], "label": "ExpressionFunctionParameter", "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.required", "type": "boolean", + "tags": [], "label": "required", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 15 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.default", "type": "Any", + "tags": [], "label": "default", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 16 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 17 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.multi", "type": "boolean", + "tags": [], "label": "multi", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.resolve", "type": "boolean", + "tags": [], "label": "resolve", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.options", "type": "Array", + "tags": [], "label": "options", "description": [], + "signature": [ + "any[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 20 }, - "signature": [ - "any[]" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.Unnamed.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.Unnamed.$2", "type": "CompoundType", + "tags": [], "label": "arg", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -2227,59 +2547,57 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", - "lineNumber": 22 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.accepts", "type": "Function", + "tags": [], "label": "accepts", + "description": [], "signature": [ "(type: string) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.accepts.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 40 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", - "lineNumber": 40 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer", "type": "Class", "tags": [], @@ -2295,75 +2613,87 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.validate", "type": "Function", + "tags": [], "label": "validate", "description": [], + "signature": [ + "() => void | Error" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 15 }, - "signature": [ - "() => void | Error" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.reuseDomNode", "type": "boolean", + "tags": [], "label": "reuseDomNode", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.render", "type": "Function", + "tags": [], "label": "render", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", - "lineNumber": 17 - }, "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { @@ -2374,22 +2704,36 @@ "text": "IInterpreterRenderHandlers" }, ") => void | Promise" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 17 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -2400,28 +2744,21 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", - "lineNumber": 19 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry", "type": "Class", "tags": [], @@ -2453,11 +2790,19 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(definition: ", { @@ -2477,13 +2822,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.register.$1", "type": "CompoundType", + "tags": [], "label": "definition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -2502,24 +2853,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", - "lineNumber": 19 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -2531,34 +2881,39 @@ }, " | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", - "lineNumber": 25 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record>" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -2594,69 +2951,71 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler", "type": "Class", "tags": [], "label": "ExpressionRenderHandler", "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.render$", "type": "Object", + "tags": [], "label": "render$", "description": [], + "signature": [ + "Observable", + "" + ], "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 38 }, - "signature": [ - "Observable", - "" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.update$", "type": "Object", + "tags": [], "label": "update$", "description": [], + "signature": [ + "Observable", + "" + ], "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 39 }, - "signature": [ - "Observable", - "" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.events$", "type": "Object", + "tags": [], "label": "events$", "description": [], - "source": { - "path": "src/plugins/expressions/public/render.ts", - "lineNumber": 40 - }, "signature": [ "Observable", "<", @@ -2668,139 +3027,186 @@ "text": "ExpressionRendererEvent" }, ">" - ] + ], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 40 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.Unnamed.$1", "type": "Object", + "tags": [], "label": "element", - "isRequired": true, + "description": [], "signature": [ "HTMLElement" ], - "description": [], "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 52 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.Unnamed.$2", "type": "Object", + "tags": [], "label": "{\n onRenderError,\n renderMode,\n syncColors,\n hasCompatibleActions = async () => false,\n }", - "isRequired": true, + "description": [], "signature": [ "ExpressionRenderHandlerParams" ], - "description": [], "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/public/render.ts", - "lineNumber": 51 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.render", "type": "Function", + "tags": [], + "label": "render", + "description": [], + "signature": [ + "(value: any, uiState?: any) => Promise" + ], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 102 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.render.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 102 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.render.$2", "type": "Any", + "tags": [], "label": "uiState", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 102 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any, uiState?: any) => Promise" - ], - "description": [], - "label": "render", - "source": { - "path": "src/plugins/expressions/public/render.ts", - "lineNumber": 102 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.destroy", "type": "Function", - "children": [], + "tags": [], + "label": "destroy", + "description": [], "signature": [ "() => void" ], - "description": [], - "label": "destroy", "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 134 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.getElement", "type": "Function", - "children": [], + "tags": [], + "label": "getElement", + "description": [], "signature": [ "() => HTMLElement" ], - "description": [], - "label": "getElement", "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 143 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.handleRenderError", "type": "Function", + "tags": [], + "label": "handleRenderError", + "description": [], + "signature": [ + "(error: ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRenderError", + "text": "ExpressionRenderError" + }, + ") => void" + ], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 147 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.handleRenderError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -2810,41 +3216,21 @@ "text": "ExpressionRenderError" } ], - "description": [], "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 147 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(error: ", - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionRenderError", - "text": "ExpressionRenderError" - }, - ") => void" - ], - "description": [], - "label": "handleRenderError", - "source": { - "path": "src/plugins/expressions/public/render.ts", - "lineNumber": 147 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/public/render.ts", - "lineNumber": 37 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsInspectorAdapter", "type": "Class", "tags": [], @@ -2861,60 +3247,69 @@ " extends ", "EventEmitter" ], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsInspectorAdapter.logAST", "type": "Function", + "tags": [], "label": "logAST", + "description": [], "signature": [ "(ast: any) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsInspectorAdapter.logAST.$1", "type": "Any", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", - "lineNumber": 14 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsInspectorAdapter.ast", "type": "Any", - "label": "ast", "tags": [], + "label": "ast", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", "lineNumber": 19 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin", "type": "Class", "tags": [], @@ -2954,21 +3349,35 @@ }, ", object, object>" ], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2979,24 +3388,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 35 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -3016,13 +3424,19 @@ }, ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], - "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -3033,24 +3447,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -3069,13 +3482,19 @@ "text": "ExpressionsStart" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -3085,44 +3504,39 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 59 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 75 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 32 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin", "type": "Class", "tags": [], @@ -3162,21 +3576,35 @@ }, ", object, object>" ], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -3187,24 +3615,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 35 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -3224,13 +3651,19 @@ }, ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], - "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -3241,24 +3674,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -3277,13 +3709,19 @@ "text": "ExpressionsStart" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -3293,44 +3731,39 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 59 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 75 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 32 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService", "type": "Class", "tags": [], @@ -3364,17 +3797,19 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 175 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.executor", "type": "Object", + "tags": [], "label": "executor", "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 175 - }, "signature": [ { "pluginId": "expressions", @@ -3384,18 +3819,20 @@ "text": "Executor" }, ">" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 176 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.renderers", "type": "Object", + "tags": [], "label": "renderers", "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 176 - }, "signature": [ { "pluginId": "expressions", @@ -3404,22 +3841,36 @@ "section": "def-common.ExpressionRendererRegistry", "text": "ExpressionRendererRegistry" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 177 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 179 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.Unnamed.$1", "type": "Object", + "tags": [], "label": "{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -3429,29 +3880,57 @@ "text": "ExpressionServiceParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 178 - } + "lineNumber": 179 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 178 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.registerFunction", "type": "Function", + "tags": [], + "label": "registerFunction", + "description": [ + "\nRegister an expression function, which will be possible to execute as\npart of the expression pipeline.\n\nBelow we register a function which simply sleeps for given number of\nmilliseconds to delay the execution and outputs its input as-is.\n\n```ts\nexpressions.registerFunction({\n name: 'sleep',\n args: {\n time: {\n aliases: ['_'],\n help: 'Time in milliseconds for how long to sleep',\n types: ['number'],\n },\n },\n help: '',\n fn: async (input, args, context) => {\n await new Promise(r => setTimeout(r, args.time));\n return input;\n },\n}\n```\n\nThe actual function is defined in the `fn` key. The function can be *async*.\nIt receives three arguments: (1) `input` is the output of the previous function\nor the initial input of the expression if the function is first in chain;\n(2) `args` are function arguments as defined in expression string, that can\nbe edited by user (e.g in case of Canvas); (3) `context` is a shared object\npassed to all functions that can be used for side-effects." + ], + "signature": [ + "(functionDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")) => void" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 219 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.registerFunction.$1", "type": "CompoundType", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -3470,52 +3949,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 219 - } + "lineNumber": 220 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsService.registerType", + "type": "Function", + "tags": [], + "label": "registerType", + "description": [], "signature": [ - "(functionDefinition: ", + "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" }, ")) => void" ], - "description": [ - "\nRegister an expression function, which will be possible to execute as\npart of the expression pipeline.\n\nBelow we register a function which simply sleeps for given number of\nmilliseconds to delay the execution and outputs its input as-is.\n\n```ts\nexpressions.registerFunction({\n name: 'sleep',\n args: {\n time: {\n aliases: ['_'],\n help: 'Time in milliseconds for how long to sleep',\n types: ['number'],\n },\n },\n help: '',\n fn: async (input, args, context) => {\n await new Promise(r => setTimeout(r, args.time));\n return input;\n },\n}\n```\n\nThe actual function is defined in the `fn` key. The function can be *async*.\nIt receives three arguments: (1) `input` is the output of the previous function\nor the initial input of the expression if the function is first in chain;\n(2) `args` are function arguments as defined in expression string, that can\nbe edited by user (e.g in case of Canvas); (3) `context` is a shared object\npassed to all functions that can be used for side-effects." - ], - "label": "registerFunction", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 218 + "lineNumber": 223 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionsService.registerType", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.registerType.$1", "type": "CompoundType", + "tags": [], "label": "typeDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -3534,50 +4016,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 223 - } + "lineNumber": 224 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsService.registerRenderer", + "type": "Function", + "tags": [], + "label": "registerRenderer", + "description": [], "signature": [ - "(typeDefinition: ", + "(definition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" }, ")) => void" ], - "description": [], - "label": "registerType", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 222 + "lineNumber": 227 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionsService.registerRenderer", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.registerRenderer.$1", "type": "CompoundType", + "tags": [], "label": "definition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -3596,50 +4083,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 227 - } + "lineNumber": 228 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsService.run", + "type": "Function", + "tags": [], + "label": "run", + "description": [], "signature": [ - "(definition: ", + "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionRenderDefinition", - "text": "AnyExpressionRenderDefinition" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | (() => ", + ", input: Input, params: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionRenderDefinition", - "text": "AnyExpressionRenderDefinition" + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" }, - ")) => void" + " | undefined) => Promise" ], - "description": [], - "label": "registerRenderer", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 226 + "lineNumber": 231 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionsService.run", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.run.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ "string | ", { @@ -3650,31 +4142,37 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 230 - } + "lineNumber": 231 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.run.$2", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "Input" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 230 - } + "lineNumber": 231 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.run.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "expressions", @@ -3685,84 +4183,69 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 230 - } + "lineNumber": 231 + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsService.getFunction", + "type": "Function", + "tags": [], + "label": "getFunction", + "description": [], "signature": [ - "(ast: string | ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - }, - ", input: Input, params: ", + "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionExecutionParams", - "text": "ExpressionExecutionParams" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" }, - " | undefined) => Promise" + " | undefined" ], - "description": [], - "label": "run", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 230 + "lineNumber": 234 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionsService.getFunction", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getFunction.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 233 - } + "lineNumber": 234 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(name: string) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" - }, - " | undefined" - ], - "description": [], - "label": "getFunction", - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 233 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getFunctions", "type": "Function", - "children": [], + "tags": [], + "label": "getFunctions", + "description": [ + "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." + ], "signature": [ "() => Record" ], - "description": [ - "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." - ], - "label": "getFunctions", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 240 + "lineNumber": 241 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getRenderer", "type": "Function", - "children": [ - { - "id": "def-public.ExpressionsService.getRenderer.$1", - "type": "string", - "label": "name", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 243 - } - } - ], + "tags": [], + "label": "getRenderer", + "description": [], "signature": [ "(name: string) => ", { @@ -3815,19 +4283,41 @@ }, " | null" ], - "description": [], - "label": "getRenderer", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 243 + "lineNumber": 244 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsService.getRenderer.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 244 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getRenderers", "type": "Function", - "children": [], + "tags": [], + "label": "getRenderers", + "description": [ + "\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances." + ], "signature": [ "() => Record>" ], - "description": [ - "\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances." - ], - "label": "getRenderers", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 250 + "lineNumber": 251 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getType", "type": "Function", - "children": [ - { - "id": "def-public.ExpressionsService.getType.$1", - "type": "string", - "label": "name", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 253 - } - } - ], + "tags": [], + "label": "getType", + "description": [], "signature": [ "(name: string) => ", { @@ -3880,19 +4355,41 @@ }, " | undefined" ], - "description": [], - "label": "getType", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 253 + "lineNumber": 254 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsService.getType.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 254 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getTypes", "type": "Function", - "children": [], + "tags": [], + "label": "getTypes", + "description": [ + "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." + ], "signature": [ "() => Record" ], - "description": [ - "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." - ], - "label": "getTypes", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 260 + "lineNumber": 261 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.execute", "type": "Function", + "tags": [], "label": "execute", "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 262 - }, "signature": [ "(ast: string | ", { @@ -3951,12 +4442,20 @@ "text": "ExecutionContract" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 263 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.fork", "type": "Function", - "children": [], + "tags": [], + "label": "fork", + "description": [], "signature": [ "() => ", { @@ -3967,24 +4466,47 @@ "text": "ExpressionsService" } ], - "description": [], - "label": "fork", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 268 + "lineNumber": 269 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.telemetry", "type": "Function", + "tags": [], + "label": "telemetry", + "description": [ + "\nExtracts telemetry from expression AST" + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", telemetryData?: Record) => Record" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 281 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.telemetry.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -3994,27 +4516,42 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 281 - } + "lineNumber": 282 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.telemetry.$2", "type": "Object", + "tags": [], "label": "telemetryData", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 282 - } + "lineNumber": 283 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsService.extract", + "type": "Function", + "tags": [], + "label": "extract", + "description": [ + "\nExtracts saved object references from expression AST" + ], "signature": [ "(state: ", { @@ -4024,28 +4561,31 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - ", telemetryData?: Record) => Record" - ], - "description": [ - "\nExtracts telemetry from expression AST" + ") => { state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; references: ", + "SavedObjectReference", + "[]; }" ], - "label": "telemetry", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 280 + "lineNumber": 293 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionsService.extract", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.extract.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -4055,13 +4595,27 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 292 - } + "lineNumber": 293 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "new expression AST with references removed and array of references" + ] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsService.inject", + "type": "Function", + "tags": [], + "label": "inject", + "description": [ + "\nInjects saved object references into expression AST" + ], "signature": [ "(state: ", { @@ -4071,40 +4625,30 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - ") => { state: ", + ", references: ", + "SavedObjectReference", + "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" - }, - "; references: ", - "SavedObjectReference", - "[]; }" - ], - "description": [ - "\nExtracts saved object references from expression AST" + } ], - "label": "extract", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 292 + "lineNumber": 303 }, - "tags": [], - "returnComment": [ - "new expression AST with references removed and array of references" - ] - }, - { - "id": "def-public.ExpressionsService.inject", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.inject.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -4114,40 +4658,55 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 - } + "lineNumber": 303 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.inject.$2", "type": "Array", + "tags": [], "label": "references", - "isRequired": true, + "description": [], "signature": [ "SavedObjectReference", "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 - } + "lineNumber": 303 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "new expression AST with references injected" + ] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsService.migrate", + "type": "Function", + "tags": [], + "label": "migrate", + "description": [ + "\nRuns the migration (if it exists) for specified version. This will run a single migration step (ie from 7.10.0 to 7.10.1)" + ], "signature": [ "(state: ", { - "pluginId": "expressions", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" }, - ", references: ", - "SavedObjectReference", - "[]) => ", + ", version: string) => ", { "pluginId": "expressions", "scope": "common", @@ -4156,28 +4715,19 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "\nInjects saved object references into expression AST" - ], - "label": "inject", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 + "lineNumber": 313 }, - "tags": [], - "returnComment": [ - "new expression AST with references injected" - ] - }, - { - "id": "def-public.ExpressionsService.migrate", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.migrate.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -4187,62 +4737,44 @@ "text": "SerializableState" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 - } + "lineNumber": 313 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.migrate.$2", "type": "string", + "tags": [], "label": "version", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 - } - } - ], - "signature": [ - "(state: ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, - ", version: string) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "lineNumber": 313 + }, + "deprecated": false, + "isRequired": true } ], - "description": [ - "\nRuns the migration (if it exists) for specified version. This will run a single migration step (ie from 7.10.0 to 7.10.1)" - ], - "label": "migrate", - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 - }, - "tags": [], "returnComment": [ "new migrated expression AST" ] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [ + "\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." + ], "signature": [ "() => Pick<", { @@ -4254,21 +4786,23 @@ }, ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], - "description": [ - "\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 320 - } + "lineNumber": 321 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.start", "type": "Function", + "tags": [], "label": "start", + "description": [ + "\nReturns Kibana Platform *start* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." + ], "signature": [ "() => ", { @@ -4279,62 +4813,66 @@ "text": "ExpressionsServiceStart" } ], - "description": [ - "\nReturns Kibana Platform *start* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 328 - } + "lineNumber": 329 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 332 - } + "lineNumber": 333 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 174 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionType", "type": "Class", "tags": [], "label": "ExpressionType", "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionType.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nA short help text." @@ -4342,82 +4880,100 @@ "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionType.validate", "type": "Function", + "tags": [], "label": "validate", "description": [ "\nType validation, useful for checking function output." ], + "signature": [ + "(type: any) => void | Error" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 23 }, - "signature": [ - "(type: any) => void | Error" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionType.create", "type": "Unknown", + "tags": [], "label": "create", "description": [], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 25 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionType.serialize", "type": "Function", + "tags": [], "label": "serialize", "description": [ "\nOptional serialization (used when passing context around client/server)." ], + "signature": [ + "((value: any) => any) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 30 }, - "signature": [ - "((value: any) => any) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionType.deserialize", "type": "Function", + "tags": [], "label": "deserialize", "description": [], + "signature": [ + "((serialized: any) => any) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 31 }, - "signature": [ - "((serialized: any) => any) | undefined" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.Unnamed.$1", "type": "Object", + "tags": [], "label": "definition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -4427,39 +4983,23 @@ "text": "AnyExpressionTypeDefinition" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 33 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.getToFn", "type": "Function", - "children": [ - { - "id": "def-public.ExpressionType.getToFn.$1", - "type": "string", - "label": "typeName", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 48 - } - } - ], + "tags": [], + "label": "getToFn", + "description": [], "signature": [ "(typeName: string) => ", { @@ -4471,34 +5011,39 @@ }, " | undefined" ], - "description": [], - "label": "getToFn", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 47 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionType.getFromFn", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.ExpressionType.getFromFn.$1", + "parentPluginId": "expressions", + "id": "def-public.ExpressionType.getToFn.$1", "type": "string", + "tags": [], "label": "typeName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 53 - } + "lineNumber": 48 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionType.getFromFn", + "type": "Function", + "tags": [], + "label": "getFromFn", + "description": [], "signature": [ "(typeName: string) => ", { @@ -4510,114 +5055,169 @@ }, " | undefined" ], - "description": [], - "label": "getFromFn", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 52 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionType.getFromFn.$1", + "type": "string", + "tags": [], + "label": "typeName", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 53 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.castsTo", "type": "Function", + "tags": [], + "label": "castsTo", + "description": [], + "signature": [ + "(value: any) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.castsTo.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionType.castsFrom", + "type": "Function", + "tags": [], + "label": "castsFrom", + "description": [], "signature": [ "(value: any) => boolean" ], - "description": [], - "label": "castsTo", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 57 + "lineNumber": 59 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionType.castsFrom", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.castsFrom.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any) => boolean" - ], - "description": [], - "label": "castsFrom", - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 59 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.to", "type": "Function", + "tags": [], + "label": "to", + "description": [], + "signature": [ + "(value: any, toTypeName: string, types: Record) => any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.to.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.to.$2", "type": "string", + "tags": [], "label": "toTypeName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.to.$3", "type": "Object", + "tags": [], "label": "types", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionType.from", + "type": "Function", + "tags": [], + "label": "from", + "description": [], "signature": [ - "(value: any, toTypeName: string, types: Record) => any" ], - "description": [], - "label": "to", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 61 + "lineNumber": 73 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionType.from", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.from.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 73 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionType.from.$2", "type": "Object", + "tags": [], "label": "types", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 73 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any, types: Record) => any" - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 73 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry", "type": "Class", "tags": [], @@ -4756,21 +5344,35 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.Unnamed.$1", "type": "Object", + "tags": [], "label": "executor", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -4781,24 +5383,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 - } + "lineNumber": 60 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(functionDefinition: ", { @@ -4818,13 +5419,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.register.$1", "type": "CompoundType", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -4843,24 +5450,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 62 - } + "lineNumber": 63 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 61 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -4872,34 +5478,39 @@ }, " | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 68 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 67 - } + "lineNumber": 68 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 67 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 71 - } + "lineNumber": 72 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -4935,23 +5548,19 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 75 - } + "lineNumber": 76 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 58 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.TablesAdapter", "type": "Class", "tags": [], @@ -4968,11 +5577,19 @@ " extends ", "EventEmitter" ], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.TablesAdapter.logDatatable", "type": "Function", + "tags": [], "label": "logDatatable", + "description": [], "signature": [ "(name: string, datatable: ", { @@ -4984,27 +5601,36 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.TablesAdapter.logDatatable.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/util/tables_adapter.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.TablesAdapter.logDatatable.$2", "type": "Object", + "tags": [], "label": "datatable", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -5014,30 +5640,23 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/util/tables_adapter.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/util/tables_adapter.ts", - "lineNumber": 15 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.TablesAdapter.tables", "type": "Object", - "label": "tables", "tags": [], + "label": "tables", "description": [], - "source": { - "path": "src/plugins/expressions/common/util/tables_adapter.ts", - "lineNumber": 20 - }, "signature": [ "{ [key: string]: ", { @@ -5048,16 +5667,18 @@ "text": "Datatable" }, "; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 20 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/util/tables_adapter.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry", "type": "Class", "tags": [], @@ -5089,21 +5710,35 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.Unnamed.$1", "type": "Object", + "tags": [], "label": "executor", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -5114,24 +5749,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 - } + "lineNumber": 38 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(typeDefinition: ", { @@ -5151,13 +5785,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.register.$1", "type": "CompoundType", + "tags": [], "label": "typeDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -5176,24 +5816,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 40 - } + "lineNumber": 41 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 39 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -5205,34 +5844,39 @@ }, " | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 45 - } + "lineNumber": 46 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 49 - } + "lineNumber": 50 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -5268,28 +5914,30 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 53 - } + "lineNumber": 54 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 36 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "expressions", "id": "def-public.buildExpression", "type": "Function", + "tags": [ + "return" + ], "label": "buildExpression", + "description": [ + "\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n" + ], "signature": [ "(initialState: string | ", { @@ -5324,15 +5972,21 @@ "text": "ExpressionAstExpressionBuilder" } ], - "description": [ - "\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 97 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.buildExpression.$1", "type": "CompoundType", + "tags": [], "label": "initialState", - "isRequired": false, + "description": [ + "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." + ], "signature": [ "string | ", { @@ -5360,31 +6014,30 @@ }, ">[] | undefined" ], - "description": [ - "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." - ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 98 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return" - ], "returnComment": [ "`this`" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 97 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.buildExpressionFunction", "type": "Function", + "tags": [ + "return" + ], "label": "buildExpressionFunction", + "description": [ + "\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n" + ], "signature": [ "(fnName: ", { @@ -5420,15 +6073,21 @@ }, "" ], - "description": [ - "\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 152 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.buildExpressionFunction.$1", "type": "Uncategorized", + "tags": [], "label": "fnName", - "isRequired": true, + "description": [ + "String representing the name of this expression function." + ], "signature": [ { "pluginId": "expressions", @@ -5439,19 +6098,22 @@ }, "[\"name\"]" ], - "description": [ - "String representing the name of this expression function." - ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 155 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.buildExpressionFunction.$2", "type": "Object", + "tags": [], "label": "initialArgs", - "isRequired": true, + "description": [ + "Object containing the arguments to this function." + ], "signature": [ "{ [K in keyof FunctionArgs]: FunctionArgs[K] | ", { @@ -5471,31 +6133,26 @@ }, "[]; }" ], - "description": [ - "Object containing the arguments to this function." - ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 163 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "`this`" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 152 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.format", "type": "Function", + "tags": [], "label": "format", + "description": [], "signature": [ "(ast: T, type: T extends ", { @@ -5507,27 +6164,36 @@ }, " ? \"expression\" : \"argument\") => string" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.format.$1", "type": "Uncategorized", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/format.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.format.$2", "type": "Uncategorized", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "T extends ", { @@ -5539,25 +6205,26 @@ }, " ? \"expression\" : \"argument\"" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/format.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/format.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.formatExpression", "type": "Function", + "tags": [], "label": "formatExpression", + "description": [ + "\nGiven expression pipeline AST, returns formatted string.\n" + ], "signature": [ "(ast: ", { @@ -5569,15 +6236,21 @@ }, ") => string" ], - "description": [ - "\nGiven expression pipeline AST, returns formatted string.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.formatExpression.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [ + "Expression pipeline AST." + ], "signature": [ { "pluginId": "expressions", @@ -5587,67 +6260,69 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "Expression pipeline AST." - ], "source": { "path": "src/plugins/expressions/common/ast/format_expression.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/format_expression.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.isExpressionAstBuilder", "type": "Function", - "label": "isExpressionAstBuilder", - "signature": [ - "(val: any) => boolean" + "tags": [ + "return" ], + "label": "isExpressionAstBuilder", "description": [ "\nType guard that checks whether a given value is an\n`ExpressionAstExpressionBuilder`. This is useful when working\nwith subexpressions, where you might be retrieving a function\nargument, and need to know whether it is an expression builder\ninstance which you can perform operations on.\n" ], + "signature": [ + "(val: any) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.isExpressionAstBuilder.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, - "signature": [ - "any" - ], "description": [ "Value you want to check." ], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "boolean" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.parse", "type": "Function", + "tags": [], "label": "parse", + "description": [], "signature": [ "(expression: E, startRule: S) => S extends \"expression\" ? ", { @@ -5666,49 +6341,59 @@ "text": "ExpressionAstArgument" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.parse.$1", "type": "Uncategorized", + "tags": [], "label": "expression", - "isRequired": true, + "description": [], "signature": [ "E" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/parse.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.parse.$2", "type": "Uncategorized", + "tags": [], "label": "startRule", - "isRequired": true, + "description": [], "signature": [ "S" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/parse.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/parse.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.parseExpression", "type": "Function", + "tags": [], "label": "parseExpression", + "description": [ + "\nGiven expression pipeline string, returns parsed AST.\n" + ], "signature": [ "(expression: string) => ", { @@ -5719,44 +6404,66 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "\nGiven expression pipeline string, returns parsed AST.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.parseExpression.$1", "type": "string", + "tags": [], "label": "expression", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Expression pipeline string." ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/expressions/common/ast/parse_expression.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/parse_expression.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRenderer", "type": "Function", + "tags": [], + "label": "ReactExpressionRenderer", + "description": [], + "signature": [ + "({ className, dataAttrs, padding, renderError, expression, onEvent, onData$, reload$, debounce, ...expressionLoaderOptions }: ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ReactExpressionRendererProps", + "text": "ReactExpressionRendererProps" + }, + ") => JSX.Element" + ], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRenderer.$1", "type": "Object", + "tags": [], "label": "{\n className,\n dataAttrs,\n padding,\n renderError,\n expression,\n onEvent,\n onData$,\n reload$,\n debounce,\n ...expressionLoaderOptions\n}", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -5766,69 +6473,57 @@ "text": "ReactExpressionRendererProps" } ], - "description": [], "source": { "path": "src/plugins/expressions/public/react_expression_renderer.tsx", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ className, dataAttrs, padding, renderError, expression, onEvent, onData$, reload$, debounce, ...expressionLoaderOptions }: ", - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ReactExpressionRendererProps", - "text": "ReactExpressionRendererProps" - }, - ") => JSX.Element" - ], - "description": [], - "label": "ReactExpressionRenderer", - "source": { - "path": "src/plugins/expressions/public/react_expression_renderer.tsx", - "lineNumber": 57 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "expressions", "id": "def-public.Datatable", "type": "Interface", + "tags": [], "label": "Datatable", "description": [ "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Datatable.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"datatable\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 99 }, - "signature": [ - "\"datatable\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Datatable.columns", "type": "Array", + "tags": [], "label": "columns", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 100 - }, "signature": [ { "pluginId": "expressions", @@ -5838,70 +6533,80 @@ "text": "DatatableColumn" }, "[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 100 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Datatable.rows", "type": "Array", + "tags": [], "label": "rows", "description": [], + "signature": [ + "Record[]" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 101 }, - "signature": [ - "Record[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 98 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.DatatableColumn", "type": "Interface", + "tags": [], "label": "DatatableColumn", "description": [ "\nThis type represents the shape of a column in a `Datatable`." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 89 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.DatatableColumn.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 90 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.DatatableColumn.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 91 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.DatatableColumn.meta", "type": "Object", + "tags": [], "label": "meta", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 92 - }, "signature": [ { "pluginId": "expressions", @@ -5910,19 +6615,25 @@ "section": "def-common.DatatableColumnMeta", "text": "DatatableColumnMeta" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 92 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 89 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionContext", "type": "Interface", + "tags": [], "label": "ExecutionContext", + "description": [ + "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." + ], "signature": [ { "pluginId": "expressions", @@ -5933,55 +6644,57 @@ }, "" ], - "description": [ - "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionContext.getSearchContext", "type": "Function", + "tags": [], "label": "getSearchContext", "description": [ "\nGet search context of the expression." ], + "signature": [ + "() => ExecutionContextSearch" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 27 }, - "signature": [ - "() => ExecutionContextSearch" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionContext.variables", "type": "Object", + "tags": [], "label": "variables", "description": [ "\nContext variables that can be consumed using `var` and `var_set` functions." ], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 32 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionContext.types", "type": "Object", + "tags": [], "label": "types", "description": [ "\nA map of available expression types." ], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 37 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionContext.abortSignal", "type": "Object", + "tags": [], "label": "abortSignal", "description": [ "\nAdds ability to abort current execution." ], + "signature": [ + "AbortSignal" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 42 }, - "signature": [ - "AbortSignal" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionContext.inspectorAdapters", "type": "Uncategorized", + "tags": [], "label": "inspectorAdapters", "description": [ "\nAdapters for `inspector` plugin." ], + "signature": [ + "InspectorAdapters" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 47 }, - "signature": [ - "InspectorAdapters" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionContext.getSearchSessionId", "type": "Function", + "tags": [], "label": "getSearchSessionId", "description": [ "\nSearch context in which expression should operate." ], + "signature": [ + "() => string | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 52 }, - "signature": [ - "() => string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionContext.getKibanaRequest", "type": "Function", + "tags": [], "label": "getKibanaRequest", "description": [ "\nGetter to retrieve the `KibanaRequest` object inside an expression function.\nUseful for functions which are running on the server and need to perform\noperations that are scoped to a specific user." ], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 59 - }, "signature": [ "(() => ", { @@ -6064,48 +6785,54 @@ "text": "KibanaRequest" }, ") | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 59 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionContext.isSyncColorsEnabled", "type": "Function", + "tags": [], "label": "isSyncColorsEnabled", "description": [ "\nReturns the state (true|false) of the sync colors across panels switch." ], + "signature": [ + "(() => boolean) | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 64 }, - "signature": [ - "(() => boolean) | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionParams", "type": "Interface", + "tags": [], "label": "ExecutionParams", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionParams.executor", "type": "Object", + "tags": [], "label": "executor", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 58 - }, "signature": [ { "pluginId": "expressions", @@ -6115,18 +6842,20 @@ "text": "Executor" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 72 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionParams.ast", "type": "Object", + "tags": [], "label": "ast", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 59 - }, "signature": [ { "pluginId": "expressions", @@ -6136,32 +6865,36 @@ "text": "ExpressionAstExpression" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 73 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionParams.expression", "type": "string", + "tags": [], "label": "expression", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 60 + "lineNumber": 74 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionParams.params", "type": "Object", + "tags": [], "label": "params", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 61 - }, "signature": [ { "pluginId": "expressions", @@ -6170,19 +6903,23 @@ "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 75 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionState", "type": "Interface", + "tags": [], "label": "ExecutionState", + "description": [], "signature": [ { "pluginId": "expressions", @@ -6201,19 +6938,19 @@ }, ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionState.ast", "type": "Object", + "tags": [], "label": "ast", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "expressions", @@ -6222,67 +6959,77 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionState.state", "type": "CompoundType", + "tags": [], "label": "state", "description": [ "\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error." ], + "signature": [ + "\"result\" | \"error\" | \"not-started\" | \"pending\"" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 28 }, - "signature": [ - "\"result\" | \"error\" | \"not-started\" | \"pending\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionState.result", "type": "Uncategorized", + "tags": [], "label": "result", "description": [ "\nResult of the expression execution." ], + "signature": [ + "Output | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 33 }, - "signature": [ - "Output | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutionState.error", "type": "Object", + "tags": [], "label": "error", "description": [ "\nError happened during the execution." ], + "signature": [ + "Error | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 38 }, - "signature": [ - "Error | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExecutorState", "type": "Interface", + "tags": [], "label": "ExecutorState", + "description": [], "signature": [ { "pluginId": "expressions", @@ -6293,19 +7040,19 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutorState.functions", "type": "Object", + "tags": [], "label": "functions", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 17 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutorState.types", "type": "Object", + "tags": [], "label": "types", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 18 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExecutorState.context", "type": "Uncategorized", + "tags": [], "label": "context", "description": [], + "signature": [ + "Context" + ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 19 }, - "signature": [ - "Context" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpressionBuilder", "type": "Interface", + "tags": [], "label": "ExpressionAstExpressionBuilder", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpressionBuilder.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nUsed to identify expression builder objects." ], + "signature": [ + "\"expression_builder\"" + ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 48 }, - "signature": [ - "\"expression_builder\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpressionBuilder.functions", "type": "Array", + "tags": [], "label": "functions", "description": [ "\nArray of each of the `buildExpressionFunction()` instances\nin this expression. Use this to remove or reorder functions\nin the expression." ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 54 - }, "signature": [ { "pluginId": "expressions", @@ -6413,22 +7170,24 @@ "text": "AnyExpressionFunctionDefinition" }, ">[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 54 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionAstExpressionBuilder.findFunction", + "type": "Function", "tags": [ "return" ], - "id": "def-public.ExpressionAstExpressionBuilder.findFunction", - "type": "Function", "label": "findFunction", "description": [ "\nRecursively searches expression for all ocurrences of the\nfunction, including in subexpressions.\n\nUseful when performing migrations on a specific function,\nas you can iterate over the array of references and update\nall functions at once.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 66 - }, "signature": [ "[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 66 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionAstExpressionBuilder.toAst", + "type": "Function", "tags": [ "return" ], - "id": "def-public.ExpressionAstExpressionBuilder.toAst", - "type": "Function", "label": "toAst", "description": [ "\nConverts expression to an AST.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 74 - }, "signature": [ "() => ", { @@ -6488,37 +7249,43 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 74 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionAstExpressionBuilder.toString", + "type": "Function", "tags": [ "return" ], - "id": "def-public.ExpressionAstExpressionBuilder.toString", - "type": "Function", "label": "toString", "description": [ "\nConverts expression to an expression string.\n" ], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 80 }, - "signature": [ - "() => string" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder", "type": "Interface", + "tags": [], "label": "ExpressionAstFunctionBuilder", + "description": [], "signature": [ { "pluginId": "expressions", @@ -6529,37 +7296,39 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nUsed to identify expression function builder objects." ], + "signature": [ + "\"expression_function_builder\"" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 63 }, - "signature": [ - "\"expression_function_builder\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.name", "type": "Uncategorized", + "tags": [], "label": "name", "description": [ "\nName of this expression function." ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 67 - }, "signature": [ { "pluginId": "expressions", @@ -6569,38 +7338,42 @@ "text": "InferFunctionDefinition" }, "[\"name\"]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 67 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.arguments", "type": "Object", + "tags": [], "label": "arguments", "description": [ "\nObject of all args currently added to the function. This is\nstructured similarly to `ExpressionAstFunction['arguments']`,\nhowever any subexpressions are returned as expression builder\ninstances instead of expression ASTs." ], + "signature": [ + "FunctionBuilderArguments" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 74 }, - "signature": [ - "FunctionBuilderArguments" - ] + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionAstFunctionBuilder.addArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-public.ExpressionAstFunctionBuilder.addArgument", - "type": "Function", "label": "addArgument", "description": [ "\nAdds an additional argument to the function. For multi-args,\nthis should be called once for each new arg. Note that TS\nwill not enforce whether multi-args are available, so only\nuse this to update an existing arg if you are certain it\nis a multi-arg.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 86 - }, "signature": [ ">(name: A, value: ", { @@ -6611,22 +7384,24 @@ "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A]) => this" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 86 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionAstFunctionBuilder.getArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-public.ExpressionAstFunctionBuilder.getArgument", - "type": "Function", "label": "getArgument", "description": [ "\nRetrieves an existing argument by name.\nUseful when you want to retrieve the current array of args and add\nsomething to it before calling `replaceArgument`. Any subexpression\narguments will be returned as expression builder instances.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 99 - }, "signature": [ ">(name: A) => (", { @@ -6637,22 +7412,24 @@ "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[] | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 99 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionAstFunctionBuilder.replaceArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-public.ExpressionAstFunctionBuilder.replaceArgument", - "type": "Function", "label": "replaceArgument", "description": [ "\nOverwrites an existing argument with a new value.\nIn order to support multi-args, the value given must always be\nan array.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 111 - }, "signature": [ ">(name: A, value: (", { @@ -6663,40 +7440,44 @@ "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[]) => this" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 111 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionAstFunctionBuilder.removeArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-public.ExpressionAstFunctionBuilder.removeArgument", - "type": "Function", "label": "removeArgument", "description": [ "\nRemoves an (optional) argument from the function.\n\nTypeScript will enforce that you only remove optional\narguments. For manipulating required args, use `replaceArgument`.\n" ], + "signature": [ + ">>(name: A) => this" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 124 }, - "signature": [ - ">>(name: A) => this" - ] + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionAstFunctionBuilder.toAst", + "type": "Function", "tags": [ "return" ], - "id": "def-public.ExpressionAstFunctionBuilder.toAst", - "type": "Function", "label": "toAst", "description": [ "\nConverts function to an AST.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 130 - }, "signature": [ "() => ", { @@ -6706,67 +7487,80 @@ "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 130 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionAstFunctionBuilder.toString", + "type": "Function", "tags": [ "return" ], - "id": "def-public.ExpressionAstFunctionBuilder.toString", - "type": "Function", "label": "toString", "description": [ "\nConverts function to an expression string.\n" ], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 136 }, - "signature": [ - "() => string" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionExecutor", "type": "Interface", - "label": "ExpressionExecutor", - "description": [], "tags": [ "deprecated" ], + "label": "ExpressionExecutor", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 24 + }, + "deprecated": true, + "references": [], "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionExecutor.interpreter", "type": "Object", + "tags": [], "label": "interpreter", "description": [], + "signature": [ + "ExpressionInterpreter" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 25 }, - "signature": [ - "ExpressionInterpreter" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/public/types/index.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition", "type": "Interface", + "tags": [], "label": "ExpressionFunctionDefinition", + "description": [ + "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." + ], "signature": [ { "pluginId": "expressions", @@ -6793,55 +7587,57 @@ }, "[]>>>" ], - "description": [ - "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.name", "type": "Uncategorized", + "tags": [], "label": "name", "description": [ "\nThe name of the function, as will be used in expression." ], + "signature": [ + "Name" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 40 }, - "signature": [ - "Name" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.disabled", "type": "CompoundType", + "tags": [], "label": "disabled", "description": [ "\nif set to true function will be disabled (but its migrate function will still be available)" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 45 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [ "\nName of type of value this function outputs." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 50 - }, "signature": [ "\"date\" | \"filter\" | ", { @@ -6854,20 +7650,22 @@ "<", "UnwrapPromiseOrReturn", "> | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 50 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [ "\nList of allowed type names for input value of this function. If this\nproperty is set the input of function will be cast to the first possible\ntype in this list. If this property is missing the input will be provided\nto the function as-is." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 58 - }, "signature": [ { "pluginId": "expressions", @@ -6877,20 +7675,22 @@ "text": "TypeToString" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 58 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.args", "type": "Object", + "tags": [], "label": "args", "description": [ "\nSpecification of arguments that function supports. This list will also be\nused for autocomplete functionality when your function is being edited." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 64 - }, "signature": [ "{ [key in keyof Arguments]: ", { @@ -6901,28 +7701,36 @@ "text": "ArgumentType" }, "; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 64 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionFunctionDefinition.aliases", + "type": "Array", "tags": [ "todo" ], - "id": "def-public.ExpressionFunctionDefinition.aliases", - "type": "Array", "label": "aliases", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 69 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nHelp text displayed in the Expression editor. This text should be\ninternationalized." @@ -6930,119 +7738,202 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 75 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.fn", "type": "Function", + "tags": [], "label": "fn", - "signature": [ - "(input: Input, args: Arguments, context: Context) => Output" - ], "description": [ "\nThe actual implementation of the function.\n" ], + "signature": [ + "(input: Input, args: Arguments, context: Context) => Output" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, - "signature": [ - "Input" - ], "description": [ "Output of the previous function, or initial input." ], + "signature": [ + "Input" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.fn.$2", "type": "Uncategorized", + "tags": [], "label": "args", - "isRequired": true, - "signature": [ - "Arguments" - ], "description": [ "Parameters set for this function in expression." ], + "signature": [ + "Arguments" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.fn.$3", "type": "Uncategorized", + "tags": [], "label": "context", - "isRequired": true, - "signature": [ - "Context" - ], "description": [ "Object with functions to perform side effects. This object\nis created for the duration of the execution of expression and is the\nsame for all functions in expression chain." ], + "signature": [ + "Context" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 86 - } + "returnComment": [] }, { + "parentPluginId": "expressions", + "id": "def-public.ExpressionFunctionDefinition.context", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-public.ExpressionFunctionDefinition.context", - "type": "Object", "label": "context", "description": [], + "signature": [ + "{ types: any[] | undefined; } | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 91 }, - "signature": [ - "{ types: any[] | undefined; } | undefined" + "deprecated": true, + "references": [ + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/public/functions/filters.ts", + "lineNumber": 60 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts", + "lineNumber": 36 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts", + "lineNumber": 41 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts", + "lineNumber": 35 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts", + "lineNumber": 24 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts", + "lineNumber": 47 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts", + "lineNumber": 32 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/escount.ts", + "lineNumber": 33 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/esdocs.ts", + "lineNumber": 36 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/essql.ts", + "lineNumber": 32 + } + } ] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions", "type": "Interface", + "tags": [], "label": "ExpressionFunctionDefinitions", "description": [ "\nA mapping of `ExpressionFunctionDefinition`s for functions which the\nExpressions services provides out-of-the-box. Any new functions registered\nby the Expressions plugin should have their types added here.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 116 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.clog", "type": "Object", + "tags": [], "label": "clog", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 117 - }, "signature": [ { "pluginId": "expressions", @@ -7051,18 +7942,20 @@ "section": "def-common.ExpressionFunctionClog", "text": "ExpressionFunctionClog" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 117 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.font", "type": "Object", + "tags": [], "label": "font", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 118 - }, "signature": [ { "pluginId": "expressions", @@ -7071,18 +7964,20 @@ "section": "def-common.ExpressionFunctionFont", "text": "ExpressionFunctionFont" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 118 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.var_set", "type": "Object", + "tags": [], "label": "var_set", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 119 - }, "signature": [ { "pluginId": "expressions", @@ -7091,18 +7986,20 @@ "section": "def-common.ExpressionFunctionVarSet", "text": "ExpressionFunctionVarSet" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 119 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.var", "type": "Object", + "tags": [], "label": "var", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 120 - }, "signature": [ { "pluginId": "expressions", @@ -7111,18 +8008,20 @@ "section": "def-common.ExpressionFunctionVar", "text": "ExpressionFunctionVar" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 120 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.theme", "type": "Object", + "tags": [], "label": "theme", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 121 - }, "signature": [ { "pluginId": "expressions", @@ -7131,18 +8030,20 @@ "section": "def-common.ExpressionFunctionTheme", "text": "ExpressionFunctionTheme" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 121 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.cumulative_sum", "type": "Object", + "tags": [], "label": "cumulative_sum", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 122 - }, "signature": [ { "pluginId": "expressions", @@ -7151,18 +8052,20 @@ "section": "def-common.ExpressionFunctionCumulativeSum", "text": "ExpressionFunctionCumulativeSum" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 122 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.derivative", "type": "Object", + "tags": [], "label": "derivative", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 123 - }, "signature": [ { "pluginId": "expressions", @@ -7171,18 +8074,20 @@ "section": "def-common.ExpressionFunctionDerivative", "text": "ExpressionFunctionDerivative" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 123 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.moving_average", "type": "Object", + "tags": [], "label": "moving_average", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 124 - }, "signature": [ { "pluginId": "expressions", @@ -7191,69 +8096,81 @@ "section": "def-common.ExpressionFunctionMovingAverage", "text": "ExpressionFunctionMovingAverage" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 124 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 116 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionImage", "type": "Interface", + "tags": [], "label": "ExpressionImage", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionImage.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"image\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 15 }, - "signature": [ - "\"image\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionImage.mode", "type": "string", + "tags": [], "label": "mode", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionImage.dataurl", "type": "string", + "tags": [], "label": "dataurl", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 17 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/image.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition", "type": "Interface", + "tags": [], "label": "ExpressionRenderDefinition", + "description": [], "signature": [ { "pluginId": "expressions", @@ -7264,13 +8181,17 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nTechnical name of the renderer, used as ID to identify renderer in\nexpression renderer registry. This must match the name of the expression\nfunction that is used to create the `type: render` object." @@ -7278,60 +8199,68 @@ "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [ "\nA user friendly name of the renderer as will be displayed to user in UI." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 26 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.validate", "type": "Function", + "tags": [], "label": "validate", "description": [ "\nUsed to validate the data before calling the render function." ], + "signature": [ + "(() => Error | undefined) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 31 }, - "signature": [ - "(() => Error | undefined) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.reuseDomNode", "type": "boolean", + "tags": [], "label": "reuseDomNode", "description": [ "\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default." @@ -7339,20 +8268,18 @@ "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 37 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.render", "type": "Function", + "tags": [], "label": "render", "description": [ "\nThe function called to render the output data of an expression." ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 42 - }, "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { @@ -7363,58 +8290,68 @@ "text": "IInterpreterRenderHandlers" }, ") => void | Promise" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 42 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererEvent", "type": "Interface", + "tags": [], "label": "ExpressionRendererEvent", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererEvent.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererEvent.data", "type": "Any", + "tags": [], "label": "data", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/public/render.ts", "lineNumber": 29 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/public/render.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderError", "type": "Interface", + "tags": [], "label": "ExpressionRenderError", + "description": [], "signature": [ { "pluginId": "expressions", @@ -7425,65 +8362,71 @@ }, " extends Error" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderError.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 54 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionRenderError.original", "type": "Object", + "tags": [], "label": "original", "description": [], + "signature": [ + "Error | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 55 }, - "signature": [ - "Error | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/public/types/index.ts", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart", "type": "Interface", + "tags": [], "label": "ExpressionsServiceStart", "description": [ "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *start* life-cycle." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 72 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getFunction", "type": "Function", + "tags": [], "label": "getFunction", "description": [ "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 78 - }, "signature": [ "(name: string) => ", { @@ -7494,20 +8437,22 @@ "text": "ExpressionFunction" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 79 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getRenderer", "type": "Function", + "tags": [], "label": "getRenderer", "description": [ "\nGet a registered `ExpressionRenderer` by its name, which was registered\nusing the `registerRenderer` method. The returned `ExpressionRenderer`\ninstance is an internal representation of the renderer in Expressions\nservice - do not mutate that object." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 86 - }, "signature": [ "(name: string) => ", { @@ -7518,20 +8463,22 @@ "text": "ExpressionRenderer" }, " | null" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 87 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getType", "type": "Function", + "tags": [], "label": "getType", "description": [ "\nGet a registered `ExpressionType` by its name, which was registered\nusing the `registerType` method. The returned `ExpressionType`\ninstance is an internal representation of the type in Expressions\nservice - do not mutate that object." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 94 - }, "signature": [ "(name: string) => ", { @@ -7542,20 +8489,22 @@ "text": "ExpressionType" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 95 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.run", "type": "Function", + "tags": [], "label": "run", "description": [ "\nExecutes expression string or a parsed expression AST and immediately\nreturns the result.\n\nBelow example will execute `sleep 100 | clog` expression with `123` initial\ninput to the first function.\n\n```ts\nexpressions.run('sleep 100 | clog', 123);\n```\n\n- `sleep 100` will delay execution by 100 milliseconds and pass the `123` input as\n its output.\n- `clog` will print to console `123` and pass it as its output.\n- The final result of the execution will be `123`.\n\nOptionally, you can pass an object as the third argument which will be used\nto extend the `ExecutionContext`—an object passed to each function\nas the third argument, that allows functions to perform side-effects.\n\n```ts\nexpressions.run('...', null, { elasticsearchClient });\n```" ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 120 - }, "signature": [ "(ast: string | ", { @@ -7574,20 +8523,22 @@ "text": "ExpressionExecutionParams" }, " | undefined) => Promise" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 121 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.execute", "type": "Function", + "tags": [], "label": "execute", "description": [ "\nStarts expression execution and immediately returns `ExecutionContract`\ninstance that tracks the progress of the execution and can be used to\ninteract with the execution." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 131 - }, "signature": [ "(ast: string | ", { @@ -7614,20 +8565,22 @@ "text": "ExecutionContract" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 132 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.fork", "type": "Function", + "tags": [], "label": "fork", "description": [ "\nCreate a new instance of `ExpressionsService`. The new instance inherits\nall state of the original `ExpressionsService`, including all expression\ntypes, expression functions and context. Also, all new types and functions\nregistered in the original services AFTER the forking event will be\navailable in the forked instance. However, all new types and functions\nregistered in the forked instances will NOT be available to the original\nservice." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 147 - }, "signature": [ "() => ", { @@ -7637,19 +8590,25 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 148 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 71 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition", "type": "Interface", + "tags": [], "label": "ExpressionTypeDefinition", + "description": [ + "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." + ], "signature": [ { "pluginId": "expressions", @@ -7660,77 +8619,83 @@ }, "" ], - "description": [ - "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.name", "type": "Uncategorized", + "tags": [], "label": "name", "description": [], + "signature": [ + "Name" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 31 }, - "signature": [ - "Name" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.validate", "type": "Function", + "tags": [], "label": "validate", "description": [], + "signature": [ + "((type: any) => void | Error) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 32 }, - "signature": [ - "((type: any) => void | Error) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.serialize", "type": "Function", + "tags": [], "label": "serialize", "description": [], + "signature": [ + "((type: Value) => SerializedType) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 33 }, - "signature": [ - "((type: Value) => SerializedType) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.deserialize", "type": "Function", + "tags": [], "label": "deserialize", "description": [], + "signature": [ + "((type: SerializedType) => Value) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 34 }, - "signature": [ - "((type: SerializedType) => Value) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.from", "type": "Object", + "tags": [], "label": "from", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/types.ts", - "lineNumber": 37 - }, "signature": [ "{ [type: string]: ", { @@ -7741,18 +8706,20 @@ "text": "ExpressionValueConverter" }, "; } | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.to", "type": "Object", + "tags": [], "label": "to", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/types.ts", - "lineNumber": 40 - }, "signature": [ "{ [type: string]: ", { @@ -7763,62 +8730,70 @@ "text": "ExpressionValueConverter" }, "; } | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 40 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.help", "type": "string", + "tags": [], "label": "help", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 43 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/types.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeStyle", "type": "Interface", + "tags": [], "label": "ExpressionTypeStyle", "description": [ "\nAn object that represents style information, typically CSS." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 120 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeStyle.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"style\"" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 121 }, - "signature": [ - "\"style\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeStyle.spec", "type": "Object", + "tags": [], "label": "spec", "description": [], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 122 - }, "signature": [ { "pluginId": "expressions", @@ -7827,200 +8802,228 @@ "section": "def-common.CSSStyle", "text": "CSSStyle" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 122 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionTypeStyle.css", "type": "string", + "tags": [], "label": "css", "description": [], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 123 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 120 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.Font", "type": "Interface", + "tags": [], "label": "Font", "description": [ "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Font.label", "type": "CompoundType", + "tags": [], "label": "label", "description": [], + "signature": [ + "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 26 }, - "signature": [ - "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Font.value", "type": "CompoundType", + "tags": [], "label": "value", "description": [], + "signature": [ + "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 27 }, - "signature": [ - "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams", "type": "Interface", + "tags": [], "label": "IExpressionLoaderParams", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.searchContext", "type": "Object", + "tags": [], "label": "searchContext", "description": [], + "signature": [ + "SerializableState", + " | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 36 }, - "signature": [ - "SerializableState", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.context", "type": "Any", + "tags": [], "label": "context", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 37 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.variables", "type": "Object", + "tags": [], "label": "variables", "description": [], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 38 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.debug", "type": "CompoundType", + "tags": [], "label": "debug", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 40 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.disableCaching", "type": "CompoundType", + "tags": [], "label": "disableCaching", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 41 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.customFunctions", "type": "Object", + "tags": [], "label": "customFunctions", "description": [], + "signature": [ + "[] | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 42 }, - "signature": [ - "[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.customRenderers", "type": "Object", + "tags": [], "label": "customRenderers", "description": [], + "signature": [ + "[] | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 43 }, - "signature": [ - "[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.uiState", "type": "Unknown", + "tags": [], "label": "uiState", "description": [], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 44 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.inspectorAdapters", "type": "Object", + "tags": [], "label": "inspectorAdapters", "description": [], - "source": { - "path": "src/plugins/expressions/public/types/index.ts", - "lineNumber": 45 - }, "signature": [ { "pluginId": "inspector", @@ -8030,75 +9033,85 @@ "text": "Adapters" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 45 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.onRenderError", "type": "Function", + "tags": [], "label": "onRenderError", "description": [], + "signature": [ + "RenderErrorHandlerFnType", + " | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 46 }, - "signature": [ - "RenderErrorHandlerFnType", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.searchSessionId", "type": "string", + "tags": [], "label": "searchSessionId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 47 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.renderMode", "type": "CompoundType", + "tags": [], "label": "renderMode", "description": [], + "signature": [ + "\"display\" | \"noInteractivity\" | \"edit\" | \"preview\" | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 48 }, - "signature": [ - "\"display\" | \"noInteractivity\" | \"edit\" | \"preview\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.syncColors", "type": "CompoundType", + "tags": [], "label": "syncColors", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/expressions/public/types/index.ts", "lineNumber": 49 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.hasCompatibleActions", "type": "Function", + "tags": [], "label": "hasCompatibleActions", "description": [], - "source": { - "path": "src/plugins/expressions/public/types/index.ts", - "lineNumber": 50 - }, "signature": [ "((event: ", { @@ -8109,118 +9122,134 @@ "text": "ExpressionRendererEvent" }, ") => Promise) | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 50 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/public/types/index.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers", "type": "Interface", + "tags": [], "label": "IInterpreterRenderHandlers", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.done", "type": "Function", + "tags": [], "label": "done", "description": [ "\nDone increments the number of rendering successes" ], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 67 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.onDestroy", "type": "Function", + "tags": [], "label": "onDestroy", "description": [], + "signature": [ + "(fn: () => void) => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 68 }, - "signature": [ - "(fn: () => void) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.reload", "type": "Function", + "tags": [], "label": "reload", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 69 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.update", "type": "Function", + "tags": [], "label": "update", "description": [], + "signature": [ + "(params: any) => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 70 }, - "signature": [ - "(params: any) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.event", "type": "Function", + "tags": [], "label": "event", "description": [], + "signature": [ + "(event: any) => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 71 }, - "signature": [ - "(event: any) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.hasCompatibleActions", "type": "Function", + "tags": [], "label": "hasCompatibleActions", "description": [], + "signature": [ + "((event: any) => Promise) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 72 }, - "signature": [ - "((event: any) => Promise) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.getRenderMode", "type": "Function", + "tags": [], "label": "getRenderMode", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 73 - }, "signature": [ "() => ", { @@ -8230,49 +9259,57 @@ "section": "def-common.RenderMode", "text": "RenderMode" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 73 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.isSyncColorsEnabled", "type": "Function", + "tags": [], "label": "isSyncColorsEnabled", "description": [], + "signature": [ + "() => boolean" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 74 }, - "signature": [ - "() => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.uiState", "type": "Unknown", + "tags": [], "label": "uiState", "description": [ "\nThis uiState interface is actually `PersistedState` from the visualizations plugin,\nbut expressions cannot know about vis or it creates a mess of circular dependencies.\nDownstream consumers of the uiState handler will need to cast for now." ], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 80 }, - "signature": [ - "unknown" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 63 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.IRegistry", "type": "Interface", + "tags": [], "label": "IRegistry", + "description": [], "signature": [ { "pluginId": "expressions", @@ -8283,202 +9320,231 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.IRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => T | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-public.IRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/types/registry.ts", "lineNumber": 10 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/types/registry.ts", - "lineNumber": 10 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.IRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/types/registry.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.IRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => T[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/types/registry.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/types/registry.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.PointSeriesColumn", "type": "Interface", + "tags": [], "label": "PointSeriesColumn", "description": [ "\nColumn in a PointSeries" ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.PointSeriesColumn.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"string\" | \"number\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 24 }, - "signature": [ - "\"string\" | \"number\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.PointSeriesColumn.role", "type": "CompoundType", + "tags": [], "label": "role", "description": [], + "signature": [ + "\"measure\" | \"dimension\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 25 }, - "signature": [ - "\"measure\" | \"dimension\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.PointSeriesColumn.expression", "type": "string", + "tags": [], "label": "expression", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 26 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.Range", "type": "Interface", + "tags": [], "label": "Range", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Range.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"range\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 15 }, - "signature": [ - "\"range\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Range.from", "type": "number", + "tags": [], "label": "from", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Range.to", "type": "number", + "tags": [], "label": "to", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Range.label", "type": "string", + "tags": [], "label": "label", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/range.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps", "type": "Interface", + "tags": [], "label": "ReactExpressionRendererProps", + "description": [], "signature": [ { "pluginId": "expressions", @@ -8496,47 +9562,51 @@ "text": "IExpressionLoaderParams" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.className", "type": "string", + "tags": [], "label": "className", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/public/react_expression_renderer.tsx", "lineNumber": 24 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.dataAttrs", "type": "Array", + "tags": [], "label": "dataAttrs", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/expressions/public/react_expression_renderer.tsx", "lineNumber": 25 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.expression", "type": "CompoundType", + "tags": [], "label": "expression", "description": [], - "source": { - "path": "src/plugins/expressions/public/react_expression_renderer.tsx", - "lineNumber": 26 - }, "signature": [ "string | ", { @@ -8546,18 +9616,20 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } - ] + ], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 26 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.renderError", "type": "Function", + "tags": [], "label": "renderError", "description": [], - "source": { - "path": "src/plugins/expressions/public/react_expression_renderer.tsx", - "lineNumber": 27 - }, "signature": [ "((message?: string | null | undefined, error?: ", { @@ -8568,32 +9640,36 @@ "text": "ExpressionRenderError" }, " | null | undefined) => React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>[]) | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 27 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.padding", "type": "CompoundType", + "tags": [], "label": "padding", "description": [], + "signature": [ + "\"m\" | \"s\" | \"l\" | \"xs\" | \"xl\" | undefined" + ], "source": { "path": "src/plugins/expressions/public/react_expression_renderer.tsx", "lineNumber": 31 }, - "signature": [ - "\"m\" | \"s\" | \"l\" | \"xs\" | \"xl\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.onEvent", "type": "Function", + "tags": [], "label": "onEvent", "description": [], - "source": { - "path": "src/plugins/expressions/public/react_expression_renderer.tsx", - "lineNumber": 32 - }, "signature": [ "((event: ", { @@ -8604,64 +9680,74 @@ "text": "ExpressionRendererEvent" }, ") => void) | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 32 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.onData$", "type": "Function", + "tags": [], "label": "onData$", "description": [], + "signature": [ + "((data: TData, adapters?: TInspectorAdapters | undefined) => void) | undefined" + ], "source": { "path": "src/plugins/expressions/public/react_expression_renderer.tsx", "lineNumber": 33 }, - "signature": [ - "((data: TData, adapters?: TInspectorAdapters | undefined) => void) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.reload$", "type": "Object", + "tags": [], "label": "reload$", "description": [ "\nAn observable which can be used to re-run the expression without destroying the component" ], + "signature": [ + "Observable", + " | undefined" + ], "source": { "path": "src/plugins/expressions/public/react_expression_renderer.tsx", "lineNumber": 37 }, - "signature": [ - "Observable", - " | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.debounce", "type": "number", + "tags": [], "label": "debounce", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/expressions/public/react_expression_renderer.tsx", "lineNumber": 38 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/public/react_expression_renderer.tsx", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.SerializedDatatable", "type": "Interface", + "tags": [], "label": "SerializedDatatable", + "description": [], "signature": [ { "pluginId": "expressions", @@ -8679,34 +9765,40 @@ "text": "Datatable" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.SerializedDatatable.rows", "type": "Array", + "tags": [], "label": "rows", "description": [], + "signature": [ + "string[][]" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 105 }, - "signature": [ - "string[][]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 104 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.SerializedFieldFormat", "type": "Interface", + "tags": [], "label": "SerializedFieldFormat", + "description": [ + "\nJSON representation of a field formatter configuration.\nIs used to carry information about how to format data in\na data table as part of the column definition." + ], "signature": [ { "pluginId": "expressions", @@ -8717,53 +9809,55 @@ }, "" ], - "description": [ - "\nJSON representation of a field formatter configuration.\nIs used to carry information about how to format data in\na data table as part of the column definition." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.SerializedFieldFormat.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 54 + "lineNumber": 56 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.SerializedFieldFormat.params", "type": "Uncategorized", + "tags": [], "label": "params", "description": [], + "signature": [ + "TParams | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 55 + "lineNumber": 57 }, - "signature": [ - "TParams | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 53 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "expressions", "id": "def-public.FontStyle", "type": "Enum", - "label": "FontStyle", "tags": [], + "label": "FontStyle", "description": [ "\nEnum of supported CSS `font-style` properties." ], @@ -8771,13 +9865,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 35 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.FontWeight", "type": "Enum", - "label": "FontWeight", "tags": [], + "label": "FontWeight", "description": [ "\nEnum of supported CSS `font-weight` properties." ], @@ -8785,13 +9881,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 43 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.Overflow", "type": "Enum", - "label": "Overflow", "tags": [], + "label": "Overflow", "description": [ "\nEnum of supported CSS `overflow` properties." ], @@ -8799,13 +9897,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 62 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.TextAlignment", "type": "Enum", - "label": "TextAlignment", "tags": [], + "label": "TextAlignment", "description": [ "\nEnum of supported CSS `text-align` properties." ], @@ -8813,13 +9913,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 72 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.TextDecoration", "type": "Enum", - "label": "TextDecoration", "tags": [], + "label": "TextDecoration", "description": [ "\nEnum of supported CSS `text-decoration` properties." ], @@ -8827,22 +9929,20 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 82 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "expressions", "id": "def-public.AnyExpressionFunctionDefinition", "type": "Type", - "label": "AnyExpressionFunctionDefinition", "tags": [], + "label": "AnyExpressionFunctionDefinition", "description": [ "\nType to capture every possible expression function definition." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 102 - }, "signature": [ "ExpressionFunctionDefinition, any, ExecutionContext<", { @@ -8856,114 +9956,128 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 102 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.AnyExpressionTypeDefinition", "type": "Type", - "label": "AnyExpressionTypeDefinition", "tags": [], + "label": "AnyExpressionTypeDefinition", "description": [], + "signature": [ + "ExpressionTypeDefinition" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 46 }, - "signature": [ - "ExpressionTypeDefinition" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ArgumentType", "type": "Type", - "label": "ArgumentType", "tags": [], + "label": "ArgumentType", "description": [ "\nThis type represents all of the possible combinations of properties of an\nArgument in an Expression Function. The presence or absence of certain fields\ninfluence the shape and presence of others within each `arg` in the specification." ], + "signature": [ + "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/arguments.ts", "lineNumber": 16 }, - "signature": [ - "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.DatatableColumnType", "type": "Type", - "label": "DatatableColumnType", "tags": [], + "label": "DatatableColumnType", "description": [ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 36 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.DatatableRow", "type": "Type", - "label": "DatatableRow", "tags": [], + "label": "DatatableRow", "description": [ "\nThis type represents a row in a `Datatable`." ], + "signature": [ + "{ [x: string]: any; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 57 }, - "signature": [ - "{ [x: string]: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionContainer", "type": "Type", - "label": "ExecutionContainer", "tags": [], + "label": "ExecutionContainer", "description": [], + "signature": [ + "StateContainer, ExecutionPureTransitions, {}>" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 73 }, - "signature": [ - "StateContainer, ExecutionPureTransitions, {}>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExecutorContainer", "type": "Type", - "label": "ExecutorContainer", "tags": [], + "label": "ExecutorContainer", "description": [], + "signature": [ + "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" + ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 55 }, - "signature": [ - "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionAstArgument", "type": "Type", - "label": "ExpressionAstArgument", "tags": [], + "label": "ExpressionAstArgument", "description": [], - "source": { - "path": "src/plugins/expressions/common/ast/types.ts", - "lineNumber": 77 - }, "signature": [ "string | number | false | true | ", { @@ -8974,48 +10088,54 @@ "text": "ExpressionAstExpression" } ], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 77 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpression", "type": "Type", - "label": "ExpressionAstExpression", "tags": [], + "label": "ExpressionAstExpression", "description": [], + "signature": [ + "{ type: 'expression'; chain: ExpressionAstFunction[]; }" + ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", "lineNumber": 16 }, - "signature": [ - "{ type: 'expression'; chain: ExpressionAstFunction[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunction", "type": "Type", - "label": "ExpressionAstFunction", "tags": [], + "label": "ExpressionAstFunction", "description": [], - "source": { - "path": "src/plugins/expressions/common/ast/types.ts", - "lineNumber": 21 - }, "signature": [ "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" ], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionAstNode", "type": "Type", - "label": "ExpressionAstNode", "tags": [], + "label": "ExpressionAstNode", "description": [], - "source": { - "path": "src/plugins/expressions/common/ast/types.ts", - "lineNumber": 11 - }, "signature": [ "string | number | false | true | ", { @@ -9034,18 +10154,20 @@ "text": "ExpressionAstExpression" } ], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionRendererComponent", "type": "Type", - "label": "ExpressionRendererComponent", "tags": [], + "label": "ExpressionRendererComponent", "description": [], - "source": { - "path": "src/plugins/expressions/public/react_expression_renderer.tsx", - "lineNumber": 49 - }, "signature": [ "(props: React.PropsWithChildren<", { @@ -9057,263 +10179,296 @@ }, ">, context: any) => React.ReactElement | null" ], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 49 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionValue", "type": "Type", - "label": "ExpressionValue", "tags": [], + "label": "ExpressionValue", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 15 }, - "signature": [ - "any" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionValueBoxed", "type": "Type", - "label": "ExpressionValueBoxed", "tags": [], + "label": "ExpressionValueBoxed", "description": [], + "signature": [ + "{ type: Type; } & Value" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 11 }, - "signature": [ - "{ type: Type; } & Value" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionValueConverter", "type": "Type", - "label": "ExpressionValueConverter", "tags": [], + "label": "ExpressionValueConverter", "description": [], + "signature": [ + "(input: I, availableTypes: Record) => O" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 17 }, - "signature": [ - "(input: I, availableTypes: Record) => O" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionValueError", "type": "Type", - "label": "ExpressionValueError", "tags": [], + "label": "ExpressionValueError", "description": [], + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "lineNumber": 17 }, - "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionValueFilter", "type": "Type", - "label": "ExpressionValueFilter", "tags": [], + "label": "ExpressionValueFilter", "description": [ "\nRepresents an object that is a Filter." ], + "signature": [ + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "lineNumber": 14 }, - "signature": [ - "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionValueNum", "type": "Type", - "label": "ExpressionValueNum", "tags": [], + "label": "ExpressionValueNum", "description": [], + "signature": [ + "{ type: \"num\"; } & { value: number; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 14 }, - "signature": [ - "{ type: \"num\"; } & { value: number; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionValueRender", "type": "Type", - "label": "ExpressionValueRender", "tags": [], + "label": "ExpressionValueRender", "description": [ "\nRepresents an object that is intended to be rendered." ], + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "lineNumber": 16 }, - "signature": [ - "{ type: \"render\"; } & { as: string; value: T; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionValueRender", "type": "Type", - "label": "ExpressionValueRender", "tags": [], + "label": "ExpressionValueRender", "description": [ "\nRepresents an object that is intended to be rendered." ], + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "lineNumber": 16 }, - "signature": [ - "{ type: \"render\"; } & { as: string; value: T; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionValueUnboxed", "type": "Type", - "label": "ExpressionValueUnboxed", "tags": [], + "label": "ExpressionValueUnboxed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 9 }, - "signature": [ - "any" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.FontLabel", "type": "Type", - "label": "FontLabel", "tags": [], + "label": "FontLabel", "description": [ "\nThis type contains a unions of all supported font labels, or the the name of\nthe font the user would see in a UI." ], + "signature": [ + "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 13 }, - "signature": [ - "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.FontValue", "type": "Type", - "label": "FontValue", "tags": [], + "label": "FontValue", "description": [ "\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property." ], + "signature": [ + "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 19 }, - "signature": [ - "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.InterpreterErrorType", "type": "Type", - "label": "InterpreterErrorType", "tags": [ "deprecated" ], + "label": "InterpreterErrorType", "description": [], + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "lineNumber": 33 }, - "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" - ], + "deprecated": true, + "references": [], "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.KnownTypeToString", "type": "Type", - "label": "KnownTypeToString", "tags": [], + "label": "KnownTypeToString", "description": [ "\nMap the type of the generic to a string-based representation of the type.\n\nIf the provided generic is its own type interface, we use the value of\nthe `type` key as a string literal type for it." ], + "signature": [ + "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", "lineNumber": 26 }, - "signature": [ - "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.PointSeries", "type": "Type", - "label": "PointSeries", "tags": [], + "label": "PointSeries", "description": [ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], + "signature": [ + "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 39 }, - "signature": [ - "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.PointSeriesColumnName", "type": "Type", - "label": "PointSeriesColumnName", "tags": [], + "label": "PointSeriesColumnName", "description": [ "\nAllowed column names in a PointSeries" ], + "signature": [ + "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 18 }, - "signature": [ - "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.PointSeriesColumns", "type": "Type", - "label": "PointSeriesColumns", "tags": [], + "label": "PointSeriesColumns", "description": [ "\nRepresents a collection of valid Columns in a PointSeries" ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 32 - }, "signature": [ "{} | Record<", { @@ -9333,33 +10488,37 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 32 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.PointSeriesRow", "type": "Type", - "label": "PointSeriesRow", "tags": [], + "label": "PointSeriesRow", "description": [], + "signature": [ + "{ [x: string]: any; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 34 }, - "signature": [ - "{ [x: string]: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererType", "type": "Type", - "label": "ReactExpressionRendererType", "tags": [], + "label": "ReactExpressionRendererType", "description": [], - "source": { - "path": "src/plugins/expressions/public/react_expression_renderer.tsx", - "lineNumber": 41 - }, "signature": [ "React.ComponentClass<", { @@ -9379,52 +10538,58 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 41 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.Style", "type": "Type", - "label": "Style", "tags": [], + "label": "Style", "description": [], + "signature": [ + "ExpressionTypeStyle" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 126 }, - "signature": [ - "ExpressionTypeStyle" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.TypeString", "type": "Type", - "label": "TypeString", "tags": [], + "label": "TypeString", "description": [ "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" ], + "signature": [ + "(T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends string ? \"string\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends boolean ? \"boolean\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends number ? \"number\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends null ? \"null\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends { type: string; } ? ({ type: string; } & (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn))[\"type\"] : never" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", "lineNumber": 39 }, - "signature": [ - "UnwrapPromiseOrReturn extends string ? \"string\" : UnwrapPromiseOrReturn extends boolean ? \"boolean\" : UnwrapPromiseOrReturn extends number ? \"number\" : UnwrapPromiseOrReturn extends null ? \"null\" : UnwrapPromiseOrReturn extends { type: string; } ? ({ type: string; } & UnwrapPromiseOrReturn)[\"type\"] : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.TypeToString", "type": "Type", - "label": "TypeToString", "tags": [], + "label": "TypeToString", "description": [ "\nThis can convert a type into a known Expression string representation of\nthat type. For example, `TypeToString` will resolve to `'datatable'`.\nThis allows Expression Functions to continue to specify their type in a\nsimple string format." ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 17 - }, "signature": [ "\"date\" | \"filter\" | ", { @@ -9436,39 +10601,43 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 17 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.UnmappedTypeStrings", "type": "Type", - "label": "UnmappedTypeStrings", "tags": [], + "label": "UnmappedTypeStrings", "description": [ "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 46 - }, "signature": [ "\"date\" | \"filter\"" ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 48 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "expressions", "id": "def-public.ExpressionsSetup", "type": "Type", - "label": "ExpressionsSetup", "tags": [], + "label": "ExpressionsSetup", "description": [ "\nExpressions public setup contract, extends {@link ExpressionsServiceSetup}" ], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 19 - }, "signature": [ "{ readonly getType: (name: string) => ", { @@ -9511,13 +10680,23 @@ "text": "ExpressionRenderer" } ], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 19 + }, + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "expressions", "id": "def-public.ExpressionsStart", "type": "Interface", + "tags": [], "label": "ExpressionsStart", + "description": [ + "\nExpressions public start contrect, extends {@link ExpressionServiceStart}" + ], "signature": [ { "pluginId": "expressions", @@ -9535,36 +10714,36 @@ "text": "ExpressionsServiceStart" } ], - "description": [ - "\nExpressions public start contrect, extends {@link ExpressionServiceStart}" - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.ExpressionLoader", "type": "Object", + "tags": [], "label": "ExpressionLoader", "description": [], + "signature": [ + "typeof ", + "ExpressionLoader" + ], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 25 }, - "signature": [ - "typeof ", - "ExpressionLoader" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.ExpressionRenderHandler", "type": "Object", + "tags": [], "label": "ExpressionRenderHandler", "description": [], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 26 - }, "signature": [ "typeof ", { @@ -9574,32 +10753,36 @@ "section": "def-public.ExpressionRenderHandler", "text": "ExpressionRenderHandler" } - ] + ], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 26 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.loader", "type": "Function", + "tags": [], "label": "loader", "description": [], + "signature": [ + "IExpressionLoader" + ], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 27 }, - "signature": [ - "IExpressionLoader" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.ReactExpressionRenderer", "type": "Function", + "tags": [], "label": "ReactExpressionRenderer", "description": [], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 28 - }, "signature": [ "({ className, dataAttrs, padding, renderError, expression, onEvent, onData$, reload$, debounce, ...expressionLoaderOptions }: ", { @@ -9610,28 +10793,31 @@ "text": "ReactExpressionRendererProps" }, ") => JSX.Element" - ] + ], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 28 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.render", "type": "Function", + "tags": [], "label": "render", "description": [], + "signature": [ + "typeof ", + "render" + ], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 29 }, - "signature": [ - "typeof ", - "render" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 24 - }, "lifecycle": "start", "initialIsOpen": true } @@ -9639,6 +10825,7 @@ "server": { "classes": [ { + "parentPluginId": "expressions", "id": "def-server.Execution", "type": "Class", "tags": [], @@ -9654,19 +10841,21 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 84 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Execution.state", "type": "Object", + "tags": [], "label": "state", "description": [ "\nDynamic state of the execution." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 80 - }, "signature": [ { "pluginId": "expressions", @@ -9700,36 +10889,40 @@ "text": "SerializableState" }, " | undefined; }>>" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 94 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Execution.input", "type": "Uncategorized", + "tags": [], "label": "input", "description": [ "\nInitial input of the execution.\n\nN.B. It is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], + "signature": [ + "Input" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 88 + "lineNumber": 102 }, - "signature": [ - "Input" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Execution.context", "type": "Object", + "tags": [], "label": "context", "description": [ "\nExecution context - object that allows to do side-effects. Context is passed\nto every function." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 94 - }, "signature": [ { "pluginId": "expressions", @@ -9741,54 +10934,25 @@ "" - ] - }, - { - "tags": [], - "id": "def-server.Execution.contract", - "type": "Object", - "label": "contract", - "description": [ - "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 134 + "lineNumber": 113 }, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContract", - "text": "ExecutionContract" - }, - "" - ] - }, - { - "tags": [], - "id": "def-server.Execution.expression", - "type": "string", - "label": "expression", - "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 140 - } + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.Execution.result", "type": "Object", - "label": "result", "tags": [], - "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 142 - }, + "label": "result", + "description": [ + "\nFuture that tracks result or error of this execution." + ], "signature": [ - "Promise>" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 140 + }, + "deprecated": false }, { - "id": "def-server.Execution.inspectorAdapters", - "type": "Uncategorized", - "label": "inspectorAdapters", + "parentPluginId": "expressions", + "id": "def-server.Execution.contract", + "type": "Object", + "tags": [], + "label": "contract", + "description": [ + "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" + }, + "" + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 153 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.Execution.expression", + "type": "string", "tags": [], + "label": "expression", "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 146 + "lineNumber": 159 }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.Execution.inspectorAdapters", + "type": "Uncategorized", + "tags": [], + "label": "inspectorAdapters", + "description": [], "signature": [ "InspectorAdapters" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 161 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.Execution.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 165 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Execution.Unnamed.$1", "type": "Object", + "tags": [], "label": "execution", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -9852,75 +11070,107 @@ "text": "ExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 - } + "lineNumber": 165 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.cancel", "type": "Function", + "tags": [], "label": "cancel", - "signature": [ - "() => void" - ], "description": [ "\nStop execution of expression." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 192 - } + "lineNumber": 229 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.start", "type": "Function", + "tags": [], "label": "start", - "signature": [ - "(input?: Input) => void" - ], "description": [ "\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], + "signature": [ + "(input?: Input) => ", + "Observable", + ">" + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 239 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Execution.start.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "Input" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 - } + "lineNumber": 239 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.invokeChain", "type": "Function", + "tags": [], "label": "invokeChain", + "description": [], "signature": [ "(chainArr: ", { @@ -9930,15 +11180,23 @@ "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, - "[], input: unknown) => Promise" + "[], input: unknown) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 263 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Execution.invokeChain.$1", "type": "Array", + "tags": [], "label": "chainArr", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -9949,38 +11207,40 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 - } + "lineNumber": 263 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Execution.invokeChain.$2", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 - } + "lineNumber": 263 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.invokeFunction", "type": "Function", + "tags": [], "label": "invokeFunction", + "description": [], "signature": [ "(fn: ", { @@ -9990,15 +11250,23 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, args: Record) => Promise" + ", input: unknown, args: Record) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 336 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Execution.invokeFunction.$1", "type": "Object", + "tags": [], "label": "fn", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10008,97 +11276,110 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 317 - } + "lineNumber": 337 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Execution.invokeFunction.$2", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 318 - } + "lineNumber": 338 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Execution.invokeFunction.$3", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 319 - } + "lineNumber": 339 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 316 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.cast", "type": "Function", + "tags": [], "label": "cast", + "description": [], "signature": [ "(value: any, toTypeNames?: string[] | undefined) => any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Execution.cast.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 - } + "lineNumber": 374 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Execution.cast.$2", "type": "Array", + "tags": [], "label": "toTypeNames", - "isRequired": false, + "description": [], "signature": [ "string[] | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 - } + "lineNumber": 374 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.resolveArgs", "type": "Function", + "tags": [], "label": "resolveArgs", + "description": [], "signature": [ "(fnDef: ", { @@ -10108,15 +11389,23 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, argAsts: any) => Promise" + ", input: unknown, argAsts: any) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 400 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Execution.resolveArgs.$1", "type": "Object", + "tags": [], "label": "fnDef", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10126,52 +11415,57 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "lineNumber": 400 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Execution.resolveArgs.$2", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "lineNumber": 400 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Execution.resolveArgs.$3", "type": "Any", + "tags": [], "label": "argAsts", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "lineNumber": 400 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.interpret", "type": "Function", + "tags": [], "label": "interpret", + "description": [], "signature": [ "(ast: ", { @@ -10181,15 +11475,23 @@ "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" }, - ", input: T) => Promise" + ", input: T) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 489 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Execution.interpret.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10199,42 +11501,38 @@ "text": "ExpressionAstNode" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 - } + "lineNumber": 489 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Execution.interpret.$2", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 - } + "lineNumber": 489 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 70 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.Executor", "type": "Class", "tags": [], @@ -10266,11 +11564,19 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 81 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.createWithDefaults", "type": "Function", + "tags": [], "label": "createWithDefaults", + "description": [], "signature": [ "typeof ", { @@ -10282,13 +11588,19 @@ }, ".createWithDefaults" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.createWithDefaults.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10299,30 +11611,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 83 - } + "lineNumber": 84 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 82 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Executor.state", "type": "Object", + "tags": [], "label": "state", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 91 - }, "signature": [ { "pluginId": "expressions", @@ -10332,20 +11637,22 @@ "text": "ExecutorContainer" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 92 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.Executor.functions", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-server.Executor.functions", - "type": "Object", "label": "functions", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 96 - }, "signature": [ { "pluginId": "expressions", @@ -10354,20 +11661,23 @@ "section": "def-common.FunctionsRegistry", "text": "FunctionsRegistry" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 97 + }, + "deprecated": true, + "references": [] }, { + "parentPluginId": "expressions", + "id": "def-server.Executor.types", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-server.Executor.types", - "type": "Object", "label": "types", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 101 - }, "signature": [ { "pluginId": "expressions", @@ -10376,22 +11686,37 @@ "section": "def-common.TypesRegistry", "text": "TypesRegistry" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 102 + }, + "deprecated": true, + "references": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.Unnamed.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10402,24 +11727,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 - } + "lineNumber": 104 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.registerFunction", "type": "Function", + "tags": [], "label": "registerFunction", + "description": [], "signature": [ "(functionDefinition: ", { @@ -10439,13 +11763,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 110 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.registerFunction.$1", "type": "CompoundType", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10464,24 +11794,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 110 - } + "lineNumber": 111 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 109 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.getFunction", "type": "Function", + "tags": [], "label": "getFunction", + "description": [], "signature": [ "(name: string) => ", { @@ -10493,34 +11822,39 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 119 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.getFunction.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 - } + "lineNumber": 119 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.getFunctions", "type": "Function", + "tags": [], "label": "getFunctions", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 122 - } + "lineNumber": 123 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.registerType", "type": "Function", + "tags": [], "label": "registerType", + "description": [], "signature": [ "(typeDefinition: ", { @@ -10564,13 +11900,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 127 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.registerType.$1", "type": "CompoundType", + "tags": [], "label": "typeDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10589,24 +11931,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 127 - } + "lineNumber": 128 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 126 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.getType", "type": "Function", + "tags": [], "label": "getType", + "description": [], "signature": [ "(name: string) => ", { @@ -10618,34 +11959,39 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 136 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.getType.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 - } + "lineNumber": 136 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.getTypes", "type": "Function", + "tags": [], "label": "getTypes", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 139 - } + "lineNumber": 140 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.extendContext", "type": "Function", + "tags": [], "label": "extendContext", + "description": [], "signature": [ "(extraContext: Record) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 144 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.extendContext.$1", "type": "Object", + "tags": [], "label": "extraContext", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 - } + "lineNumber": 144 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.context", "type": "Object", - "label": "context", "tags": [], + "label": "context", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 147 + "lineNumber": 148 }, - "signature": [ - "Record" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.Executor.run", "type": "Function", + "tags": [], "label": "run", + "description": [ + "\nExecute expression and return result.\n" + ], "signature": [ "(ast: string | ", { @@ -10732,17 +12089,40 @@ "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, - ") => Promise" - ], - "description": [ - "\nExecute expression and return result.\n" + ") => ", + "Observable", + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"error\", { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + } ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 160 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.run.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [ + "Expression AST or a string representing expression." + ], "signature": [ "string | ", { @@ -10753,35 +12133,39 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "Expression AST or a string representing expression." - ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 160 - } + "lineNumber": 161 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Executor.run.$2", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, - "signature": [ - "Input" - ], "description": [ "Initial input to the first expression function." ], + "signature": [ + "Input" + ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 161 - } + "lineNumber": 162 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Executor.run.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10791,24 +12175,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 162 - } + "lineNumber": 163 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 159 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.createExecution", "type": "Function", + "tags": [], "label": "createExecution", + "description": [], "signature": [ "(ast: string | ", { @@ -10844,13 +12227,19 @@ }, ">" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 168 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.createExecution.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ "string | ", { @@ -10861,17 +12250,20 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 170 - } + "lineNumber": 169 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Executor.createExecution.$2", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10881,24 +12273,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 171 - } + "lineNumber": 170 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 169 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.inject", "type": "Function", + "tags": [], "label": "inject", + "description": [], "signature": [ "(ast: ", { @@ -10919,13 +12310,19 @@ "text": "ExpressionAstExpression" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 216 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.inject.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10935,39 +12332,41 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 - } + "lineNumber": 216 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Executor.inject.$2", "type": "Array", + "tags": [], "label": "references", - "isRequired": true, + "description": [], "signature": [ "SavedObjectReference", "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 - } + "lineNumber": 216 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.extract", "type": "Function", + "tags": [], "label": "extract", + "description": [], "signature": [ "(ast: ", { @@ -10989,13 +12388,19 @@ "SavedObjectReference", "[]; }" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 229 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.extract.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -11005,24 +12410,23 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 - } + "lineNumber": 229 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.telemetry", "type": "Function", + "tags": [], "label": "telemetry", + "description": [], "signature": [ "(ast: ", { @@ -11034,13 +12438,19 @@ }, ", telemetryData: Record) => Record" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 240 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.telemetry.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -11050,38 +12460,40 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 - } + "lineNumber": 240 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Executor.telemetry.$2", "type": "Object", + "tags": [], "label": "telemetryData", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 - } + "lineNumber": 240 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.migrate", "type": "Function", + "tags": [], "label": "migrate", + "description": [], "signature": [ "(ast: ", { @@ -11100,13 +12512,19 @@ "text": "ExpressionAstExpression" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 248 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.Executor.migrate.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -11116,38 +12534,40 @@ "text": "SerializableState" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 - } + "lineNumber": 248 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Executor.migrate.$2", "type": "string", + "tags": [], "label": "version", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 - } + "lineNumber": 248 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.fork", "type": "Function", + "tags": [], "label": "fork", + "description": [], "signature": [ "() => ", { @@ -11159,23 +12579,19 @@ }, "" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 258 - } + "lineNumber": 257 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 80 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction", "type": "Class", "tags": [], @@ -11207,129 +12623,147 @@ }, "[]>>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nName of function" ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 22 - } + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [ "\nAliases that can be used instead of `name`." ], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 27 + "lineNumber": 26 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future." ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 34 - } + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.fn", "type": "Function", + "tags": [], "label": "fn", "description": [ "\nFunction to run function (context, args)" ], + "signature": [ + "(input: any, params: Record, handlers: object) => any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 39 + "lineNumber": 38 }, - "signature": [ - "(input: any, params: Record, handlers: object) => any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nA short help text." ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 44 - } + "lineNumber": 43 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.args", "type": "Object", "tags": [], - "children": [], + "label": "args", "description": [ "\nSpecification of expression function parameters." ], - "label": "args", "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 49 - } + "lineNumber": 48 + }, + "deprecated": false, + "children": [] }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [ "\nType of inputs that this function supports." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 54 + "lineNumber": 53 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.disabled", "type": "boolean", + "tags": [], "label": "disabled", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 56 - } + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.telemetry", "type": "Function", + "tags": [], "label": "telemetry", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 57 - }, "signature": [ "(state: Record, telemetryData: Record) => Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.extract", "type": "Function", + "tags": [], "label": "extract", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 61 - }, "signature": [ "(state: Record; references: ", "SavedObjectReference", "[]; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 60 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.inject", "type": "Function", + "tags": [], "label": "inject", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 64 - }, "signature": [ "(state: Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 63 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.migrations", "type": "Object", + "tags": [], "label": "migrations", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 68 - }, "signature": [ "{ [key: string]: (state: ", { @@ -11434,22 +12874,36 @@ "text": "SerializableState" }, "; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 67 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.Unnamed.$1", "type": "Object", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -11459,204 +12913,237 @@ "text": "AnyExpressionFunctionDefinition" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 72 - } + "lineNumber": 71 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 72 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.accepts", "type": "Function", + "tags": [], + "label": "accepts", + "description": [], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 105 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.accepts.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 107 - } + "lineNumber": 105 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(type: string) => boolean" - ], - "description": [], - "label": "accepts", - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 107 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter", "type": "Class", "tags": [], "label": "ExpressionFunctionParameter", "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.required", "type": "boolean", + "tags": [], "label": "required", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 15 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.default", "type": "Any", + "tags": [], "label": "default", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 16 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 17 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.multi", "type": "boolean", + "tags": [], "label": "multi", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.resolve", "type": "boolean", + "tags": [], "label": "resolve", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.options", "type": "Array", + "tags": [], "label": "options", "description": [], + "signature": [ + "any[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 20 }, - "signature": [ - "any[]" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.Unnamed.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.Unnamed.$2", "type": "CompoundType", + "tags": [], "label": "arg", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -11667,59 +13154,57 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", - "lineNumber": 22 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.accepts", "type": "Function", + "tags": [], "label": "accepts", + "description": [], "signature": [ "(type: string) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.accepts.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 40 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", - "lineNumber": 40 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer", "type": "Class", "tags": [], @@ -11735,75 +13220,87 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.validate", "type": "Function", + "tags": [], "label": "validate", "description": [], + "signature": [ + "() => void | Error" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 15 }, - "signature": [ - "() => void | Error" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.reuseDomNode", "type": "boolean", + "tags": [], "label": "reuseDomNode", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.render", "type": "Function", + "tags": [], "label": "render", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", - "lineNumber": 17 - }, "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { @@ -11814,22 +13311,36 @@ "text": "IInterpreterRenderHandlers" }, ") => void | Promise" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 17 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -11840,28 +13351,21 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", - "lineNumber": 19 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry", "type": "Class", "tags": [], @@ -11893,11 +13397,19 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(definition: ", { @@ -11917,13 +13429,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.register.$1", "type": "CompoundType", + "tags": [], "label": "definition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -11942,24 +13460,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", - "lineNumber": 19 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -11971,34 +13488,39 @@ }, " | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", - "lineNumber": 25 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record>" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -12034,23 +13558,19 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin", "type": "Class", "tags": [], @@ -12090,17 +13610,19 @@ }, ", object, object>" ], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.expressions", "type": "Object", + "tags": [], "label": "expressions", "description": [], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "expressions", @@ -12109,22 +13631,36 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" } - ] + ], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 18 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -12135,24 +13671,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/server/plugin.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 20 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -12172,13 +13707,19 @@ }, ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], - "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -12189,24 +13730,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/server/plugin.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 22 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -12225,13 +13765,19 @@ "text": "ExpressionsServiceStart" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -12241,44 +13787,39 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/plugins/expressions/server/plugin.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 32 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/server/plugin.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin", "type": "Class", "tags": [], @@ -12318,17 +13859,19 @@ }, ", object, object>" ], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.expressions", "type": "Object", + "tags": [], "label": "expressions", "description": [], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "expressions", @@ -12337,22 +13880,36 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" } - ] + ], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 18 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -12363,24 +13920,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/server/plugin.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 20 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -12400,13 +13956,19 @@ }, ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], - "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -12417,24 +13979,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/server/plugin.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 22 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -12453,13 +14014,19 @@ "text": "ExpressionsServiceStart" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -12469,65 +14036,68 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/plugins/expressions/server/plugin.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 32 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/server/plugin.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionType", "type": "Class", "tags": [], "label": "ExpressionType", "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionType.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nA short help text." @@ -12535,82 +14105,100 @@ "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionType.validate", "type": "Function", + "tags": [], "label": "validate", "description": [ "\nType validation, useful for checking function output." ], + "signature": [ + "(type: any) => void | Error" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 23 }, - "signature": [ - "(type: any) => void | Error" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionType.create", "type": "Unknown", + "tags": [], "label": "create", "description": [], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 25 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionType.serialize", "type": "Function", + "tags": [], "label": "serialize", "description": [ "\nOptional serialization (used when passing context around client/server)." ], + "signature": [ + "((value: any) => any) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 30 }, - "signature": [ - "((value: any) => any) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionType.deserialize", "type": "Function", + "tags": [], "label": "deserialize", "description": [], + "signature": [ + "((serialized: any) => any) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 31 }, - "signature": [ - "((serialized: any) => any) | undefined" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.Unnamed.$1", "type": "Object", + "tags": [], "label": "definition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -12620,39 +14208,23 @@ "text": "AnyExpressionTypeDefinition" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 33 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.getToFn", "type": "Function", - "children": [ - { - "id": "def-server.ExpressionType.getToFn.$1", - "type": "string", - "label": "typeName", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 48 - } - } - ], + "tags": [], + "label": "getToFn", + "description": [], "signature": [ "(typeName: string) => ", { @@ -12664,34 +14236,39 @@ }, " | undefined" ], - "description": [], - "label": "getToFn", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 47 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.ExpressionType.getFromFn", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-server.ExpressionType.getFromFn.$1", + "parentPluginId": "expressions", + "id": "def-server.ExpressionType.getToFn.$1", "type": "string", + "tags": [], "label": "typeName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 53 - } + "lineNumber": 48 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-server.ExpressionType.getFromFn", + "type": "Function", + "tags": [], + "label": "getFromFn", + "description": [], "signature": [ "(typeName: string) => ", { @@ -12703,114 +14280,169 @@ }, " | undefined" ], - "description": [], - "label": "getFromFn", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 52 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.ExpressionType.getFromFn.$1", + "type": "string", + "tags": [], + "label": "typeName", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 53 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.castsTo", "type": "Function", + "tags": [], + "label": "castsTo", + "description": [], + "signature": [ + "(value: any) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.castsTo.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-server.ExpressionType.castsFrom", + "type": "Function", + "tags": [], + "label": "castsFrom", + "description": [], "signature": [ "(value: any) => boolean" ], - "description": [], - "label": "castsTo", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 57 + "lineNumber": 59 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.ExpressionType.castsFrom", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.castsFrom.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any) => boolean" - ], - "description": [], - "label": "castsFrom", - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 59 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.to", "type": "Function", + "tags": [], + "label": "to", + "description": [], + "signature": [ + "(value: any, toTypeName: string, types: Record) => any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.to.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.to.$2", "type": "string", + "tags": [], "label": "toTypeName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.to.$3", "type": "Object", + "tags": [], "label": "types", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-server.ExpressionType.from", + "type": "Function", + "tags": [], + "label": "from", + "description": [], "signature": [ - "(value: any, toTypeName: string, types: Record) => any" ], - "description": [], - "label": "to", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 61 + "lineNumber": 73 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.ExpressionType.from", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.from.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 73 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionType.from.$2", "type": "Object", + "tags": [], "label": "types", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 73 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any, types: Record) => any" - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 73 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry", "type": "Class", "tags": [], @@ -12949,21 +14569,35 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.Unnamed.$1", "type": "Object", + "tags": [], "label": "executor", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -12974,24 +14608,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 - } + "lineNumber": 60 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(functionDefinition: ", { @@ -13011,13 +14644,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.register.$1", "type": "CompoundType", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -13036,24 +14675,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 62 - } + "lineNumber": 63 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 61 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -13065,34 +14703,39 @@ }, " | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 68 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 67 - } + "lineNumber": 68 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 67 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 71 - } + "lineNumber": 72 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -13128,23 +14773,19 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 75 - } + "lineNumber": 76 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 58 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry", "type": "Class", "tags": [], @@ -13176,21 +14817,35 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.Unnamed.$1", "type": "Object", + "tags": [], "label": "executor", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -13201,24 +14856,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 - } + "lineNumber": 38 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(typeDefinition: ", { @@ -13238,13 +14892,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.register.$1", "type": "CompoundType", + "tags": [], "label": "typeDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -13263,24 +14923,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 40 - } + "lineNumber": 41 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 39 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -13292,34 +14951,39 @@ }, " | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 45 - } + "lineNumber": 46 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 49 - } + "lineNumber": 50 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -13355,28 +15021,30 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 53 - } + "lineNumber": 54 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 36 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "expressions", "id": "def-server.buildExpression", "type": "Function", + "tags": [ + "return" + ], "label": "buildExpression", + "description": [ + "\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n" + ], "signature": [ "(initialState: string | ", { @@ -13411,15 +15079,21 @@ "text": "ExpressionAstExpressionBuilder" } ], - "description": [ - "\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 97 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.buildExpression.$1", "type": "CompoundType", + "tags": [], "label": "initialState", - "isRequired": false, + "description": [ + "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." + ], "signature": [ "string | ", { @@ -13447,31 +15121,30 @@ }, ">[] | undefined" ], - "description": [ - "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." - ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 98 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return" - ], "returnComment": [ "`this`" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 97 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.buildExpressionFunction", "type": "Function", + "tags": [ + "return" + ], "label": "buildExpressionFunction", + "description": [ + "\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n" + ], "signature": [ "(fnName: ", { @@ -13507,15 +15180,21 @@ }, "" ], - "description": [ - "\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 152 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.buildExpressionFunction.$1", "type": "Uncategorized", + "tags": [], "label": "fnName", - "isRequired": true, + "description": [ + "String representing the name of this expression function." + ], "signature": [ { "pluginId": "expressions", @@ -13526,19 +15205,22 @@ }, "[\"name\"]" ], - "description": [ - "String representing the name of this expression function." - ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 155 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.buildExpressionFunction.$2", "type": "Object", + "tags": [], "label": "initialArgs", - "isRequired": true, + "description": [ + "Object containing the arguments to this function." + ], "signature": [ "{ [K in keyof FunctionArgs]: FunctionArgs[K] | ", { @@ -13558,31 +15240,26 @@ }, "[]; }" ], - "description": [ - "Object containing the arguments to this function." - ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 163 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "`this`" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 152 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.format", "type": "Function", + "tags": [], "label": "format", + "description": [], "signature": [ "(ast: T, type: T extends ", { @@ -13594,27 +15271,36 @@ }, " ? \"expression\" : \"argument\") => string" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.format.$1", "type": "Uncategorized", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/format.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.format.$2", "type": "Uncategorized", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "T extends ", { @@ -13626,25 +15312,26 @@ }, " ? \"expression\" : \"argument\"" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/format.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/format.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.formatExpression", "type": "Function", + "tags": [], "label": "formatExpression", + "description": [ + "\nGiven expression pipeline AST, returns formatted string.\n" + ], "signature": [ "(ast: ", { @@ -13656,15 +15343,21 @@ }, ") => string" ], - "description": [ - "\nGiven expression pipeline AST, returns formatted string.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.formatExpression.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [ + "Expression pipeline AST." + ], "signature": [ { "pluginId": "expressions", @@ -13674,67 +15367,69 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "Expression pipeline AST." - ], "source": { "path": "src/plugins/expressions/common/ast/format_expression.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/format_expression.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.isExpressionAstBuilder", "type": "Function", - "label": "isExpressionAstBuilder", - "signature": [ - "(val: any) => boolean" + "tags": [ + "return" ], + "label": "isExpressionAstBuilder", "description": [ "\nType guard that checks whether a given value is an\n`ExpressionAstExpressionBuilder`. This is useful when working\nwith subexpressions, where you might be retrieving a function\nargument, and need to know whether it is an expression builder\ninstance which you can perform operations on.\n" ], + "signature": [ + "(val: any) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.isExpressionAstBuilder.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, - "signature": [ - "any" - ], "description": [ "Value you want to check." ], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "boolean" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.parse", "type": "Function", + "tags": [], "label": "parse", + "description": [], "signature": [ "(expression: E, startRule: S) => S extends \"expression\" ? ", { @@ -13753,49 +15448,59 @@ "text": "ExpressionAstArgument" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.parse.$1", "type": "Uncategorized", + "tags": [], "label": "expression", - "isRequired": true, + "description": [], "signature": [ "E" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/parse.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.parse.$2", "type": "Uncategorized", + "tags": [], "label": "startRule", - "isRequired": true, + "description": [], "signature": [ "S" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/parse.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/parse.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.parseExpression", "type": "Function", + "tags": [], "label": "parseExpression", + "description": [ + "\nGiven expression pipeline string, returns parsed AST.\n" + ], "signature": [ "(expression: string) => ", { @@ -13806,70 +15511,75 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "\nGiven expression pipeline string, returns parsed AST.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.parseExpression.$1", "type": "string", + "tags": [], "label": "expression", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Expression pipeline string." ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/expressions/common/ast/parse_expression.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/parse_expression.ts", - "lineNumber": 17 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "expressions", "id": "def-server.Datatable", "type": "Interface", + "tags": [], "label": "Datatable", "description": [ "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Datatable.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"datatable\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 99 }, - "signature": [ - "\"datatable\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Datatable.columns", "type": "Array", + "tags": [], "label": "columns", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 100 - }, "signature": [ { "pluginId": "expressions", @@ -13879,70 +15589,80 @@ "text": "DatatableColumn" }, "[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 100 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Datatable.rows", "type": "Array", + "tags": [], "label": "rows", "description": [], + "signature": [ + "Record[]" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 101 }, - "signature": [ - "Record[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 98 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.DatatableColumn", "type": "Interface", + "tags": [], "label": "DatatableColumn", "description": [ "\nThis type represents the shape of a column in a `Datatable`." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 89 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.DatatableColumn.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 90 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.DatatableColumn.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 91 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.DatatableColumn.meta", "type": "Object", + "tags": [], "label": "meta", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 92 - }, "signature": [ { "pluginId": "expressions", @@ -13951,19 +15671,25 @@ "section": "def-common.DatatableColumnMeta", "text": "DatatableColumnMeta" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 92 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 89 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExecutionContext", "type": "Interface", + "tags": [], "label": "ExecutionContext", + "description": [ + "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." + ], "signature": [ { "pluginId": "expressions", @@ -13974,55 +15700,57 @@ }, "" ], - "description": [ - "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionContext.getSearchContext", "type": "Function", + "tags": [], "label": "getSearchContext", "description": [ "\nGet search context of the expression." ], + "signature": [ + "() => ExecutionContextSearch" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 27 }, - "signature": [ - "() => ExecutionContextSearch" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionContext.variables", "type": "Object", + "tags": [], "label": "variables", "description": [ "\nContext variables that can be consumed using `var` and `var_set` functions." ], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 32 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionContext.types", "type": "Object", + "tags": [], "label": "types", "description": [ "\nA map of available expression types." ], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 37 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionContext.abortSignal", "type": "Object", + "tags": [], "label": "abortSignal", "description": [ "\nAdds ability to abort current execution." ], + "signature": [ + "AbortSignal" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 42 }, - "signature": [ - "AbortSignal" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionContext.inspectorAdapters", "type": "Uncategorized", + "tags": [], "label": "inspectorAdapters", "description": [ "\nAdapters for `inspector` plugin." ], + "signature": [ + "InspectorAdapters" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 47 }, - "signature": [ - "InspectorAdapters" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionContext.getSearchSessionId", "type": "Function", + "tags": [], "label": "getSearchSessionId", "description": [ "\nSearch context in which expression should operate." ], + "signature": [ + "() => string | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 52 }, - "signature": [ - "() => string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionContext.getKibanaRequest", "type": "Function", + "tags": [], "label": "getKibanaRequest", "description": [ "\nGetter to retrieve the `KibanaRequest` object inside an expression function.\nUseful for functions which are running on the server and need to perform\noperations that are scoped to a specific user." ], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 59 - }, "signature": [ "(() => ", { @@ -14105,48 +15841,54 @@ "text": "KibanaRequest" }, ") | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 59 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionContext.isSyncColorsEnabled", "type": "Function", + "tags": [], "label": "isSyncColorsEnabled", "description": [ "\nReturns the state (true|false) of the sync colors across panels switch." ], - "source": { + "signature": [ + "(() => boolean) | undefined" + ], + "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 64 }, - "signature": [ - "(() => boolean) | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExecutionParams", "type": "Interface", + "tags": [], "label": "ExecutionParams", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionParams.executor", "type": "Object", + "tags": [], "label": "executor", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 58 - }, "signature": [ { "pluginId": "expressions", @@ -14156,18 +15898,20 @@ "text": "Executor" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 72 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionParams.ast", "type": "Object", + "tags": [], "label": "ast", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 59 - }, "signature": [ { "pluginId": "expressions", @@ -14177,32 +15921,36 @@ "text": "ExpressionAstExpression" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 73 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionParams.expression", "type": "string", + "tags": [], "label": "expression", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 60 + "lineNumber": 74 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionParams.params", "type": "Object", + "tags": [], "label": "params", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 61 - }, "signature": [ { "pluginId": "expressions", @@ -14211,19 +15959,23 @@ "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 75 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExecutionState", "type": "Interface", + "tags": [], "label": "ExecutionState", + "description": [], "signature": [ { "pluginId": "expressions", @@ -14242,19 +15994,19 @@ }, ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionState.ast", "type": "Object", + "tags": [], "label": "ast", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "expressions", @@ -14263,67 +16015,77 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionState.state", "type": "CompoundType", + "tags": [], "label": "state", "description": [ "\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error." ], + "signature": [ + "\"result\" | \"error\" | \"not-started\" | \"pending\"" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 28 }, - "signature": [ - "\"result\" | \"error\" | \"not-started\" | \"pending\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionState.result", "type": "Uncategorized", + "tags": [], "label": "result", "description": [ "\nResult of the expression execution." ], + "signature": [ + "Output | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 33 }, - "signature": [ - "Output | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutionState.error", "type": "Object", + "tags": [], "label": "error", "description": [ "\nError happened during the execution." ], + "signature": [ + "Error | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 38 }, - "signature": [ - "Error | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExecutorState", "type": "Interface", + "tags": [], "label": "ExecutorState", + "description": [], "signature": [ { "pluginId": "expressions", @@ -14334,19 +16096,19 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutorState.functions", "type": "Object", + "tags": [], "label": "functions", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 17 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutorState.types", "type": "Object", + "tags": [], "label": "types", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 18 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExecutorState.context", "type": "Uncategorized", + "tags": [], "label": "context", "description": [], + "signature": [ + "Context" + ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 19 }, - "signature": [ - "Context" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpressionBuilder", "type": "Interface", + "tags": [], "label": "ExpressionAstExpressionBuilder", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpressionBuilder.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nUsed to identify expression builder objects." ], + "signature": [ + "\"expression_builder\"" + ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 48 }, - "signature": [ - "\"expression_builder\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpressionBuilder.functions", "type": "Array", + "tags": [], "label": "functions", "description": [ "\nArray of each of the `buildExpressionFunction()` instances\nin this expression. Use this to remove or reorder functions\nin the expression." ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 54 - }, "signature": [ { "pluginId": "expressions", @@ -14454,22 +16226,24 @@ "text": "AnyExpressionFunctionDefinition" }, ">[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 54 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionAstExpressionBuilder.findFunction", + "type": "Function", "tags": [ "return" ], - "id": "def-server.ExpressionAstExpressionBuilder.findFunction", - "type": "Function", "label": "findFunction", "description": [ "\nRecursively searches expression for all ocurrences of the\nfunction, including in subexpressions.\n\nUseful when performing migrations on a specific function,\nas you can iterate over the array of references and update\nall functions at once.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 66 - }, "signature": [ "[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 66 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionAstExpressionBuilder.toAst", + "type": "Function", "tags": [ "return" ], - "id": "def-server.ExpressionAstExpressionBuilder.toAst", - "type": "Function", "label": "toAst", "description": [ "\nConverts expression to an AST.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 74 - }, "signature": [ "() => ", { @@ -14529,37 +16305,43 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 74 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionAstExpressionBuilder.toString", + "type": "Function", "tags": [ "return" ], - "id": "def-server.ExpressionAstExpressionBuilder.toString", - "type": "Function", "label": "toString", "description": [ "\nConverts expression to an expression string.\n" ], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 80 }, - "signature": [ - "() => string" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder", "type": "Interface", + "tags": [], "label": "ExpressionAstFunctionBuilder", + "description": [], "signature": [ { "pluginId": "expressions", @@ -14570,37 +16352,39 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nUsed to identify expression function builder objects." ], + "signature": [ + "\"expression_function_builder\"" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 63 }, - "signature": [ - "\"expression_function_builder\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.name", "type": "Uncategorized", + "tags": [], "label": "name", "description": [ "\nName of this expression function." ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 67 - }, "signature": [ { "pluginId": "expressions", @@ -14610,38 +16394,42 @@ "text": "InferFunctionDefinition" }, "[\"name\"]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 67 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.arguments", "type": "Object", + "tags": [], "label": "arguments", "description": [ "\nObject of all args currently added to the function. This is\nstructured similarly to `ExpressionAstFunction['arguments']`,\nhowever any subexpressions are returned as expression builder\ninstances instead of expression ASTs." ], + "signature": [ + "FunctionBuilderArguments" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 74 }, - "signature": [ - "FunctionBuilderArguments" - ] + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionAstFunctionBuilder.addArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-server.ExpressionAstFunctionBuilder.addArgument", - "type": "Function", "label": "addArgument", "description": [ "\nAdds an additional argument to the function. For multi-args,\nthis should be called once for each new arg. Note that TS\nwill not enforce whether multi-args are available, so only\nuse this to update an existing arg if you are certain it\nis a multi-arg.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 86 - }, "signature": [ ">(name: A, value: ", { @@ -14652,22 +16440,24 @@ "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A]) => this" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 86 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionAstFunctionBuilder.getArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-server.ExpressionAstFunctionBuilder.getArgument", - "type": "Function", "label": "getArgument", "description": [ "\nRetrieves an existing argument by name.\nUseful when you want to retrieve the current array of args and add\nsomething to it before calling `replaceArgument`. Any subexpression\narguments will be returned as expression builder instances.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 99 - }, "signature": [ ">(name: A) => (", { @@ -14678,22 +16468,24 @@ "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[] | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 99 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionAstFunctionBuilder.replaceArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-server.ExpressionAstFunctionBuilder.replaceArgument", - "type": "Function", "label": "replaceArgument", "description": [ "\nOverwrites an existing argument with a new value.\nIn order to support multi-args, the value given must always be\nan array.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 111 - }, "signature": [ ">(name: A, value: (", { @@ -14704,40 +16496,44 @@ "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[]) => this" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 111 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionAstFunctionBuilder.removeArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-server.ExpressionAstFunctionBuilder.removeArgument", - "type": "Function", "label": "removeArgument", "description": [ "\nRemoves an (optional) argument from the function.\n\nTypeScript will enforce that you only remove optional\narguments. For manipulating required args, use `replaceArgument`.\n" ], + "signature": [ + ">>(name: A) => this" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 124 }, - "signature": [ - ">>(name: A) => this" - ] + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionAstFunctionBuilder.toAst", + "type": "Function", "tags": [ "return" ], - "id": "def-server.ExpressionAstFunctionBuilder.toAst", - "type": "Function", "label": "toAst", "description": [ "\nConverts function to an AST.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 130 - }, "signature": [ "() => ", { @@ -14747,37 +16543,45 @@ "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 130 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionAstFunctionBuilder.toString", + "type": "Function", "tags": [ "return" ], - "id": "def-server.ExpressionAstFunctionBuilder.toString", - "type": "Function", "label": "toString", "description": [ "\nConverts function to an expression string.\n" ], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 136 }, - "signature": [ - "() => string" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition", "type": "Interface", + "tags": [], "label": "ExpressionFunctionDefinition", + "description": [ + "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." + ], "signature": [ { "pluginId": "expressions", @@ -14804,55 +16608,57 @@ }, "[]>>>" ], - "description": [ - "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.name", "type": "Uncategorized", + "tags": [], "label": "name", "description": [ "\nThe name of the function, as will be used in expression." ], + "signature": [ + "Name" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 40 }, - "signature": [ - "Name" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.disabled", "type": "CompoundType", + "tags": [], "label": "disabled", "description": [ "\nif set to true function will be disabled (but its migrate function will still be available)" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 45 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [ "\nName of type of value this function outputs." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 50 - }, "signature": [ "\"date\" | \"filter\" | ", { @@ -14865,20 +16671,22 @@ "<", "UnwrapPromiseOrReturn", "> | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 50 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [ "\nList of allowed type names for input value of this function. If this\nproperty is set the input of function will be cast to the first possible\ntype in this list. If this property is missing the input will be provided\nto the function as-is." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 58 - }, "signature": [ { "pluginId": "expressions", @@ -14888,20 +16696,22 @@ "text": "TypeToString" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 58 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.args", "type": "Object", + "tags": [], "label": "args", "description": [ "\nSpecification of arguments that function supports. This list will also be\nused for autocomplete functionality when your function is being edited." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 64 - }, "signature": [ "{ [key in keyof Arguments]: ", { @@ -14912,28 +16722,36 @@ "text": "ArgumentType" }, "; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 64 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionFunctionDefinition.aliases", + "type": "Array", "tags": [ "todo" ], - "id": "def-server.ExpressionFunctionDefinition.aliases", - "type": "Array", "label": "aliases", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 69 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nHelp text displayed in the Expression editor. This text should be\ninternationalized." @@ -14941,119 +16759,202 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 75 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.fn", "type": "Function", + "tags": [], "label": "fn", - "signature": [ - "(input: Input, args: Arguments, context: Context) => Output" - ], "description": [ "\nThe actual implementation of the function.\n" ], + "signature": [ + "(input: Input, args: Arguments, context: Context) => Output" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, - "signature": [ - "Input" - ], "description": [ "Output of the previous function, or initial input." ], + "signature": [ + "Input" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.fn.$2", "type": "Uncategorized", + "tags": [], "label": "args", - "isRequired": true, - "signature": [ - "Arguments" - ], "description": [ "Parameters set for this function in expression." ], + "signature": [ + "Arguments" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.fn.$3", "type": "Uncategorized", + "tags": [], "label": "context", - "isRequired": true, - "signature": [ - "Context" - ], "description": [ "Object with functions to perform side effects. This object\nis created for the duration of the execution of expression and is the\nsame for all functions in expression chain." ], + "signature": [ + "Context" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 86 - } + "returnComment": [] }, { + "parentPluginId": "expressions", + "id": "def-server.ExpressionFunctionDefinition.context", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-server.ExpressionFunctionDefinition.context", - "type": "Object", "label": "context", "description": [], + "signature": [ + "{ types: any[] | undefined; } | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 91 }, - "signature": [ - "{ types: any[] | undefined; } | undefined" + "deprecated": true, + "references": [ + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/public/functions/filters.ts", + "lineNumber": 60 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts", + "lineNumber": 36 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts", + "lineNumber": 41 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts", + "lineNumber": 35 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts", + "lineNumber": 24 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts", + "lineNumber": 47 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts", + "lineNumber": 32 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/escount.ts", + "lineNumber": 33 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/esdocs.ts", + "lineNumber": 36 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/essql.ts", + "lineNumber": 32 + } + } ] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions", "type": "Interface", + "tags": [], "label": "ExpressionFunctionDefinitions", "description": [ "\nA mapping of `ExpressionFunctionDefinition`s for functions which the\nExpressions services provides out-of-the-box. Any new functions registered\nby the Expressions plugin should have their types added here.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 116 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.clog", "type": "Object", + "tags": [], "label": "clog", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 117 - }, "signature": [ { "pluginId": "expressions", @@ -15062,18 +16963,20 @@ "section": "def-common.ExpressionFunctionClog", "text": "ExpressionFunctionClog" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 117 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.font", "type": "Object", + "tags": [], "label": "font", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 118 - }, "signature": [ { "pluginId": "expressions", @@ -15082,18 +16985,20 @@ "section": "def-common.ExpressionFunctionFont", "text": "ExpressionFunctionFont" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 118 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.var_set", "type": "Object", + "tags": [], "label": "var_set", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 119 - }, "signature": [ { "pluginId": "expressions", @@ -15102,18 +17007,20 @@ "section": "def-common.ExpressionFunctionVarSet", "text": "ExpressionFunctionVarSet" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 119 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.var", "type": "Object", + "tags": [], "label": "var", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 120 - }, "signature": [ { "pluginId": "expressions", @@ -15122,18 +17029,20 @@ "section": "def-common.ExpressionFunctionVar", "text": "ExpressionFunctionVar" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 120 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.theme", "type": "Object", + "tags": [], "label": "theme", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 121 - }, "signature": [ { "pluginId": "expressions", @@ -15142,18 +17051,20 @@ "section": "def-common.ExpressionFunctionTheme", "text": "ExpressionFunctionTheme" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 121 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.cumulative_sum", "type": "Object", + "tags": [], "label": "cumulative_sum", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 122 - }, "signature": [ { "pluginId": "expressions", @@ -15162,18 +17073,20 @@ "section": "def-common.ExpressionFunctionCumulativeSum", "text": "ExpressionFunctionCumulativeSum" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 122 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.derivative", "type": "Object", + "tags": [], "label": "derivative", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 123 - }, "signature": [ { "pluginId": "expressions", @@ -15182,18 +17095,20 @@ "section": "def-common.ExpressionFunctionDerivative", "text": "ExpressionFunctionDerivative" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 123 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.moving_average", "type": "Object", + "tags": [], "label": "moving_average", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 124 - }, "signature": [ { "pluginId": "expressions", @@ -15202,69 +17117,81 @@ "section": "def-common.ExpressionFunctionMovingAverage", "text": "ExpressionFunctionMovingAverage" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 124 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 116 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionImage", "type": "Interface", + "tags": [], "label": "ExpressionImage", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionImage.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"image\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 15 }, - "signature": [ - "\"image\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionImage.mode", "type": "string", + "tags": [], "label": "mode", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionImage.dataurl", "type": "string", + "tags": [], "label": "dataurl", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 17 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/image.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition", "type": "Interface", + "tags": [], "label": "ExpressionRenderDefinition", + "description": [], "signature": [ { "pluginId": "expressions", @@ -15275,13 +17202,17 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nTechnical name of the renderer, used as ID to identify renderer in\nexpression renderer registry. This must match the name of the expression\nfunction that is used to create the `type: render` object." @@ -15289,60 +17220,68 @@ "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [ "\nA user friendly name of the renderer as will be displayed to user in UI." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 26 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.validate", "type": "Function", + "tags": [], "label": "validate", "description": [ "\nUsed to validate the data before calling the render function." ], + "signature": [ + "(() => Error | undefined) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 31 }, - "signature": [ - "(() => Error | undefined) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.reuseDomNode", "type": "boolean", + "tags": [], "label": "reuseDomNode", "description": [ "\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default." @@ -15350,20 +17289,18 @@ "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 37 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.render", "type": "Function", + "tags": [], "label": "render", "description": [ "\nThe function called to render the output data of an expression." ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 42 - }, "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { @@ -15374,19 +17311,25 @@ "text": "IInterpreterRenderHandlers" }, ") => void | Promise" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 42 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition", "type": "Interface", + "tags": [], "label": "ExpressionTypeDefinition", + "description": [ + "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." + ], "signature": [ { "pluginId": "expressions", @@ -15397,77 +17340,83 @@ }, "" ], - "description": [ - "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.name", "type": "Uncategorized", + "tags": [], "label": "name", "description": [], + "signature": [ + "Name" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 31 }, - "signature": [ - "Name" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.validate", "type": "Function", + "tags": [], "label": "validate", "description": [], + "signature": [ + "((type: any) => void | Error) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 32 }, - "signature": [ - "((type: any) => void | Error) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.serialize", "type": "Function", + "tags": [], "label": "serialize", "description": [], + "signature": [ + "((type: Value) => SerializedType) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 33 }, - "signature": [ - "((type: Value) => SerializedType) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.deserialize", "type": "Function", + "tags": [], "label": "deserialize", "description": [], + "signature": [ + "((type: SerializedType) => Value) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 34 }, - "signature": [ - "((type: SerializedType) => Value) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.from", "type": "Object", + "tags": [], "label": "from", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/types.ts", - "lineNumber": 37 - }, "signature": [ "{ [type: string]: ", { @@ -15478,18 +17427,20 @@ "text": "ExpressionValueConverter" }, "; } | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.to", "type": "Object", + "tags": [], "label": "to", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/types.ts", - "lineNumber": 40 - }, "signature": [ "{ [type: string]: ", { @@ -15500,62 +17451,70 @@ "text": "ExpressionValueConverter" }, "; } | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 40 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.help", "type": "string", + "tags": [], "label": "help", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 43 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/types.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeStyle", "type": "Interface", + "tags": [], "label": "ExpressionTypeStyle", "description": [ "\nAn object that represents style information, typically CSS." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 120 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeStyle.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"style\"" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 121 }, - "signature": [ - "\"style\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeStyle.spec", "type": "Object", + "tags": [], "label": "spec", "description": [], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 122 - }, "signature": [ { "pluginId": "expressions", @@ -15564,173 +17523,197 @@ "section": "def-common.CSSStyle", "text": "CSSStyle" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 122 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.ExpressionTypeStyle.css", "type": "string", + "tags": [], "label": "css", "description": [], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 123 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 120 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.Font", "type": "Interface", + "tags": [], "label": "Font", "description": [ "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Font.label", "type": "CompoundType", + "tags": [], "label": "label", "description": [], + "signature": [ + "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 26 }, - "signature": [ - "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Font.value", "type": "CompoundType", + "tags": [], "label": "value", "description": [], + "signature": [ + "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 27 }, - "signature": [ - "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers", "type": "Interface", + "tags": [], "label": "IInterpreterRenderHandlers", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.done", "type": "Function", + "tags": [], "label": "done", "description": [ "\nDone increments the number of rendering successes" ], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 67 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.onDestroy", "type": "Function", + "tags": [], "label": "onDestroy", "description": [], + "signature": [ + "(fn: () => void) => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 68 }, - "signature": [ - "(fn: () => void) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.reload", "type": "Function", + "tags": [], "label": "reload", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 69 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.update", "type": "Function", + "tags": [], "label": "update", "description": [], + "signature": [ + "(params: any) => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 70 }, - "signature": [ - "(params: any) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.event", "type": "Function", + "tags": [], "label": "event", "description": [], + "signature": [ + "(event: any) => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 71 }, - "signature": [ - "(event: any) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.hasCompatibleActions", "type": "Function", + "tags": [], "label": "hasCompatibleActions", "description": [], + "signature": [ + "((event: any) => Promise) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 72 }, - "signature": [ - "((event: any) => Promise) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.getRenderMode", "type": "Function", + "tags": [], "label": "getRenderMode", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 73 - }, "signature": [ "() => ", { @@ -15740,49 +17723,57 @@ "section": "def-common.RenderMode", "text": "RenderMode" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 73 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.isSyncColorsEnabled", "type": "Function", + "tags": [], "label": "isSyncColorsEnabled", "description": [], + "signature": [ + "() => boolean" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 74 }, - "signature": [ - "() => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.uiState", "type": "Unknown", + "tags": [], "label": "uiState", "description": [ "\nThis uiState interface is actually `PersistedState` from the visualizations plugin,\nbut expressions cannot know about vis or it creates a mess of circular dependencies.\nDownstream consumers of the uiState handler will need to cast for now." ], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 80 }, - "signature": [ - "unknown" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 63 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.IRegistry", "type": "Interface", + "tags": [], "label": "IRegistry", + "description": [], "signature": [ { "pluginId": "expressions", @@ -15793,202 +17784,231 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.IRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => T | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-server.IRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/types/registry.ts", "lineNumber": 10 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/types/registry.ts", - "lineNumber": 10 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.IRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/types/registry.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.IRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => T[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/types/registry.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/types/registry.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.PointSeriesColumn", "type": "Interface", + "tags": [], "label": "PointSeriesColumn", "description": [ "\nColumn in a PointSeries" ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.PointSeriesColumn.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"string\" | \"number\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 24 }, - "signature": [ - "\"string\" | \"number\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.PointSeriesColumn.role", "type": "CompoundType", + "tags": [], "label": "role", "description": [], + "signature": [ + "\"measure\" | \"dimension\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 25 }, - "signature": [ - "\"measure\" | \"dimension\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.PointSeriesColumn.expression", "type": "string", + "tags": [], "label": "expression", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 26 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.Range", "type": "Interface", + "tags": [], "label": "Range", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Range.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"range\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 15 }, - "signature": [ - "\"range\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Range.from", "type": "number", + "tags": [], "label": "from", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Range.to", "type": "number", + "tags": [], "label": "to", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Range.label", "type": "string", + "tags": [], "label": "label", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/range.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.SerializedDatatable", "type": "Interface", + "tags": [], "label": "SerializedDatatable", + "description": [], "signature": [ { "pluginId": "expressions", @@ -16006,34 +18026,40 @@ "text": "Datatable" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.SerializedDatatable.rows", "type": "Array", + "tags": [], "label": "rows", "description": [], + "signature": [ + "string[][]" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 105 }, - "signature": [ - "string[][]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 104 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.SerializedFieldFormat", "type": "Interface", + "tags": [], "label": "SerializedFieldFormat", + "description": [ + "\nJSON representation of a field formatter configuration.\nIs used to carry information about how to format data in\na data table as part of the column definition." + ], "signature": [ { "pluginId": "expressions", @@ -16044,53 +18070,55 @@ }, "" ], - "description": [ - "\nJSON representation of a field formatter configuration.\nIs used to carry information about how to format data in\na data table as part of the column definition." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.SerializedFieldFormat.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 54 + "lineNumber": 56 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.SerializedFieldFormat.params", "type": "Uncategorized", + "tags": [], "label": "params", "description": [], + "signature": [ + "TParams | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 55 + "lineNumber": 57 }, - "signature": [ - "TParams | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 53 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "expressions", "id": "def-server.FontStyle", "type": "Enum", - "label": "FontStyle", "tags": [], + "label": "FontStyle", "description": [ "\nEnum of supported CSS `font-style` properties." ], @@ -16098,13 +18126,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 35 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.FontWeight", "type": "Enum", - "label": "FontWeight", "tags": [], + "label": "FontWeight", "description": [ "\nEnum of supported CSS `font-weight` properties." ], @@ -16112,13 +18142,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 43 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.Overflow", "type": "Enum", - "label": "Overflow", "tags": [], + "label": "Overflow", "description": [ "\nEnum of supported CSS `overflow` properties." ], @@ -16126,13 +18158,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 62 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.TextAlignment", "type": "Enum", - "label": "TextAlignment", "tags": [], + "label": "TextAlignment", "description": [ "\nEnum of supported CSS `text-align` properties." ], @@ -16140,13 +18174,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 72 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.TextDecoration", "type": "Enum", - "label": "TextDecoration", "tags": [], + "label": "TextDecoration", "description": [ "\nEnum of supported CSS `text-decoration` properties." ], @@ -16154,22 +18190,20 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 82 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "expressions", "id": "def-server.AnyExpressionFunctionDefinition", "type": "Type", - "label": "AnyExpressionFunctionDefinition", "tags": [], + "label": "AnyExpressionFunctionDefinition", "description": [ "\nType to capture every possible expression function definition." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 102 - }, "signature": [ "ExpressionFunctionDefinition, any, ExecutionContext<", { @@ -16183,114 +18217,128 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 102 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.AnyExpressionTypeDefinition", "type": "Type", - "label": "AnyExpressionTypeDefinition", "tags": [], + "label": "AnyExpressionTypeDefinition", "description": [], + "signature": [ + "ExpressionTypeDefinition" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 46 }, - "signature": [ - "ExpressionTypeDefinition" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ArgumentType", "type": "Type", - "label": "ArgumentType", "tags": [], + "label": "ArgumentType", "description": [ "\nThis type represents all of the possible combinations of properties of an\nArgument in an Expression Function. The presence or absence of certain fields\ninfluence the shape and presence of others within each `arg` in the specification." ], + "signature": [ + "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/arguments.ts", "lineNumber": 16 }, - "signature": [ - "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.DatatableColumnType", "type": "Type", - "label": "DatatableColumnType", "tags": [], + "label": "DatatableColumnType", "description": [ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 36 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.DatatableRow", "type": "Type", - "label": "DatatableRow", "tags": [], + "label": "DatatableRow", "description": [ "\nThis type represents a row in a `Datatable`." ], + "signature": [ + "{ [x: string]: any; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 57 }, - "signature": [ - "{ [x: string]: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExecutionContainer", "type": "Type", - "label": "ExecutionContainer", "tags": [], + "label": "ExecutionContainer", "description": [], + "signature": [ + "StateContainer, ExecutionPureTransitions, {}>" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 73 }, - "signature": [ - "StateContainer, ExecutionPureTransitions, {}>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExecutorContainer", "type": "Type", - "label": "ExecutorContainer", "tags": [], + "label": "ExecutorContainer", "description": [], + "signature": [ + "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" + ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 55 }, - "signature": [ - "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionAstArgument", "type": "Type", - "label": "ExpressionAstArgument", "tags": [], + "label": "ExpressionAstArgument", "description": [], - "source": { - "path": "src/plugins/expressions/common/ast/types.ts", - "lineNumber": 77 - }, "signature": [ "string | number | false | true | ", { @@ -16301,48 +18349,54 @@ "text": "ExpressionAstExpression" } ], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 77 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpression", "type": "Type", - "label": "ExpressionAstExpression", "tags": [], + "label": "ExpressionAstExpression", "description": [], + "signature": [ + "{ type: 'expression'; chain: ExpressionAstFunction[]; }" + ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", "lineNumber": 16 }, - "signature": [ - "{ type: 'expression'; chain: ExpressionAstFunction[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunction", "type": "Type", - "label": "ExpressionAstFunction", "tags": [], + "label": "ExpressionAstFunction", "description": [], + "signature": [ + "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", "lineNumber": 21 }, - "signature": [ - "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionAstNode", "type": "Type", - "label": "ExpressionAstNode", "tags": [], + "label": "ExpressionAstNode", "description": [], - "source": { - "path": "src/plugins/expressions/common/ast/types.ts", - "lineNumber": 11 - }, "signature": [ "string | number | false | true | ", { @@ -16361,263 +18415,296 @@ "text": "ExpressionAstExpression" } ], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionValue", "type": "Type", - "label": "ExpressionValue", "tags": [], + "label": "ExpressionValue", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 15 }, - "signature": [ - "any" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionValueBoxed", "type": "Type", - "label": "ExpressionValueBoxed", "tags": [], + "label": "ExpressionValueBoxed", "description": [], + "signature": [ + "{ type: Type; } & Value" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 11 }, - "signature": [ - "{ type: Type; } & Value" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionValueConverter", "type": "Type", - "label": "ExpressionValueConverter", "tags": [], + "label": "ExpressionValueConverter", "description": [], + "signature": [ + "(input: I, availableTypes: Record) => O" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 17 }, - "signature": [ - "(input: I, availableTypes: Record) => O" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionValueError", "type": "Type", - "label": "ExpressionValueError", "tags": [], + "label": "ExpressionValueError", "description": [], + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "lineNumber": 17 }, - "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionValueFilter", "type": "Type", - "label": "ExpressionValueFilter", "tags": [], + "label": "ExpressionValueFilter", "description": [ "\nRepresents an object that is a Filter." ], + "signature": [ + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "lineNumber": 14 }, - "signature": [ - "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionValueNum", "type": "Type", - "label": "ExpressionValueNum", "tags": [], + "label": "ExpressionValueNum", "description": [], + "signature": [ + "{ type: \"num\"; } & { value: number; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 14 }, - "signature": [ - "{ type: \"num\"; } & { value: number; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionValueRender", "type": "Type", - "label": "ExpressionValueRender", "tags": [], + "label": "ExpressionValueRender", "description": [ "\nRepresents an object that is intended to be rendered." ], + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "lineNumber": 16 }, - "signature": [ - "{ type: \"render\"; } & { as: string; value: T; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionValueRender", "type": "Type", - "label": "ExpressionValueRender", "tags": [], + "label": "ExpressionValueRender", "description": [ "\nRepresents an object that is intended to be rendered." ], + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "lineNumber": 16 }, - "signature": [ - "{ type: \"render\"; } & { as: string; value: T; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionValueUnboxed", "type": "Type", - "label": "ExpressionValueUnboxed", "tags": [], + "label": "ExpressionValueUnboxed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 9 }, - "signature": [ - "any" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.FontLabel", "type": "Type", - "label": "FontLabel", "tags": [], + "label": "FontLabel", "description": [ "\nThis type contains a unions of all supported font labels, or the the name of\nthe font the user would see in a UI." ], + "signature": [ + "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 13 }, - "signature": [ - "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.FontValue", "type": "Type", - "label": "FontValue", "tags": [], + "label": "FontValue", "description": [ "\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property." ], + "signature": [ + "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 19 }, - "signature": [ - "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.InterpreterErrorType", "type": "Type", - "label": "InterpreterErrorType", "tags": [ "deprecated" ], + "label": "InterpreterErrorType", "description": [], + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "lineNumber": 33 }, - "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" - ], + "deprecated": true, + "references": [], "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.KnownTypeToString", "type": "Type", - "label": "KnownTypeToString", "tags": [], + "label": "KnownTypeToString", "description": [ "\nMap the type of the generic to a string-based representation of the type.\n\nIf the provided generic is its own type interface, we use the value of\nthe `type` key as a string literal type for it." ], + "signature": [ + "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", "lineNumber": 26 }, - "signature": [ - "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.PointSeries", "type": "Type", - "label": "PointSeries", "tags": [], + "label": "PointSeries", "description": [ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], + "signature": [ + "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 39 }, - "signature": [ - "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.PointSeriesColumnName", "type": "Type", - "label": "PointSeriesColumnName", "tags": [], + "label": "PointSeriesColumnName", "description": [ "\nAllowed column names in a PointSeries" ], + "signature": [ + "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 18 }, - "signature": [ - "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.PointSeriesColumns", "type": "Type", - "label": "PointSeriesColumns", "tags": [], + "label": "PointSeriesColumns", "description": [ "\nRepresents a collection of valid Columns in a PointSeries" ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 32 - }, "signature": [ "{} | Record<", { @@ -16637,67 +18724,75 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 32 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.PointSeriesRow", "type": "Type", - "label": "PointSeriesRow", "tags": [], + "label": "PointSeriesRow", "description": [], + "signature": [ + "{ [x: string]: any; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 34 }, - "signature": [ - "{ [x: string]: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.Style", "type": "Type", - "label": "Style", "tags": [], + "label": "Style", "description": [], + "signature": [ + "ExpressionTypeStyle" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 126 }, - "signature": [ - "ExpressionTypeStyle" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.TypeString", "type": "Type", - "label": "TypeString", "tags": [], + "label": "TypeString", "description": [ "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" ], + "signature": [ + "(T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends string ? \"string\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends boolean ? \"boolean\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends number ? \"number\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends null ? \"null\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends { type: string; } ? ({ type: string; } & (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn))[\"type\"] : never" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", "lineNumber": 39 }, - "signature": [ - "UnwrapPromiseOrReturn extends string ? \"string\" : UnwrapPromiseOrReturn extends boolean ? \"boolean\" : UnwrapPromiseOrReturn extends number ? \"number\" : UnwrapPromiseOrReturn extends null ? \"null\" : UnwrapPromiseOrReturn extends { type: string; } ? ({ type: string; } & UnwrapPromiseOrReturn)[\"type\"] : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.TypeToString", "type": "Type", - "label": "TypeToString", "tags": [], + "label": "TypeToString", "description": [ "\nThis can convert a type into a known Expression string representation of\nthat type. For example, `TypeToString` will resolve to `'datatable'`.\nThis allows Expression Functions to continue to specify their type in a\nsimple string format." ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 17 - }, "signature": [ "\"date\" | \"filter\" | ", { @@ -16709,37 +18804,41 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 17 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.UnmappedTypeStrings", "type": "Type", - "label": "UnmappedTypeStrings", "tags": [], + "label": "UnmappedTypeStrings", "description": [ "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 46 - }, "signature": [ "\"date\" | \"filter\"" ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 48 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerSetup", "type": "Type", - "label": "ExpressionsServerSetup", "tags": [], + "label": "ExpressionsServerSetup", "description": [], - "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 12 - }, "signature": [ "{ readonly getType: (name: string) => ", { @@ -16782,22 +18881,29 @@ "text": "ExpressionRenderer" } ], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 12 + }, + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "expressions", "id": "def-server.ExpressionsServerStart", "type": "Type", - "label": "ExpressionsServerStart", "tags": [], + "label": "ExpressionsServerStart", "description": [], + "signature": [ + "ExpressionsServiceStart" + ], "source": { "path": "src/plugins/expressions/server/plugin.ts", "lineNumber": 14 }, - "signature": [ - "ExpressionsServiceStart" - ], + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -16805,6 +18911,7 @@ "common": { "classes": [ { + "parentPluginId": "expressions", "id": "def-common.Execution", "type": "Class", "tags": [], @@ -16820,19 +18927,21 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 84 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Execution.state", "type": "Object", + "tags": [], "label": "state", "description": [ "\nDynamic state of the execution." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 80 - }, "signature": [ { "pluginId": "expressions", @@ -16866,36 +18975,40 @@ "text": "SerializableState" }, " | undefined; }>>" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 94 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Execution.input", "type": "Uncategorized", + "tags": [], "label": "input", "description": [ "\nInitial input of the execution.\n\nN.B. It is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], + "signature": [ + "Input" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 88 + "lineNumber": 102 }, - "signature": [ - "Input" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Execution.context", "type": "Object", + "tags": [], "label": "context", "description": [ "\nExecution context - object that allows to do side-effects. Context is passed\nto every function." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 94 - }, "signature": [ { "pluginId": "expressions", @@ -16907,54 +19020,25 @@ "" - ] - }, - { - "tags": [], - "id": "def-common.Execution.contract", - "type": "Object", - "label": "contract", - "description": [ - "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 134 + "lineNumber": 113 }, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContract", - "text": "ExecutionContract" - }, - "" - ] - }, - { - "tags": [], - "id": "def-common.Execution.expression", - "type": "string", - "label": "expression", - "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 140 - } + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.Execution.result", "type": "Object", - "label": "result", "tags": [], - "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 142 - }, + "label": "result", + "description": [ + "\nFuture that tracks result or error of this execution." + ], "signature": [ - "Promise>" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 140 + }, + "deprecated": false }, { - "id": "def-common.Execution.inspectorAdapters", - "type": "Uncategorized", - "label": "inspectorAdapters", + "parentPluginId": "expressions", + "id": "def-common.Execution.contract", + "type": "Object", "tags": [], + "label": "contract", + "description": [ + "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" + }, + "" + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 153 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.Execution.expression", + "type": "string", + "tags": [], + "label": "expression", "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 146 + "lineNumber": 159 }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.Execution.inspectorAdapters", + "type": "Uncategorized", + "tags": [], + "label": "inspectorAdapters", + "description": [], "signature": [ "InspectorAdapters" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 161 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.Execution.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 165 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Execution.Unnamed.$1", "type": "Object", + "tags": [], "label": "execution", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -17018,75 +19156,107 @@ "text": "ExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 - } + "lineNumber": 165 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.cancel", "type": "Function", + "tags": [], "label": "cancel", - "signature": [ - "() => void" - ], "description": [ "\nStop execution of expression." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 192 - } + "lineNumber": 229 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.start", "type": "Function", + "tags": [], "label": "start", - "signature": [ - "(input?: Input) => void" - ], "description": [ "\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], + "signature": [ + "(input?: Input) => ", + "Observable", + ">" + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 239 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Execution.start.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "Input" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 - } + "lineNumber": 239 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.invokeChain", "type": "Function", + "tags": [], "label": "invokeChain", + "description": [], "signature": [ "(chainArr: ", { @@ -17096,15 +19266,23 @@ "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, - "[], input: unknown) => Promise" + "[], input: unknown) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 263 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Execution.invokeChain.$1", "type": "Array", + "tags": [], "label": "chainArr", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -17115,38 +19293,40 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 - } + "lineNumber": 263 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Execution.invokeChain.$2", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 - } + "lineNumber": 263 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.invokeFunction", "type": "Function", + "tags": [], "label": "invokeFunction", + "description": [], "signature": [ "(fn: ", { @@ -17156,15 +19336,23 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, args: Record) => Promise" + ", input: unknown, args: Record) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 336 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Execution.invokeFunction.$1", "type": "Object", + "tags": [], "label": "fn", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -17174,97 +19362,110 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 317 - } + "lineNumber": 337 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Execution.invokeFunction.$2", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 318 - } + "lineNumber": 338 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Execution.invokeFunction.$3", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 319 - } + "lineNumber": 339 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 316 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.cast", "type": "Function", + "tags": [], "label": "cast", + "description": [], "signature": [ "(value: any, toTypeNames?: string[] | undefined) => any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Execution.cast.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 - } + "lineNumber": 374 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Execution.cast.$2", "type": "Array", + "tags": [], "label": "toTypeNames", - "isRequired": false, + "description": [], "signature": [ "string[] | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 - } + "lineNumber": 374 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.resolveArgs", "type": "Function", + "tags": [], "label": "resolveArgs", + "description": [], "signature": [ "(fnDef: ", { @@ -17274,15 +19475,23 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, argAsts: any) => Promise" + ", input: unknown, argAsts: any) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 400 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Execution.resolveArgs.$1", "type": "Object", + "tags": [], "label": "fnDef", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -17292,52 +19501,57 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "lineNumber": 400 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Execution.resolveArgs.$2", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "lineNumber": 400 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Execution.resolveArgs.$3", "type": "Any", + "tags": [], "label": "argAsts", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "lineNumber": 400 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.interpret", "type": "Function", + "tags": [], "label": "interpret", + "description": [], "signature": [ "(ast: ", { @@ -17347,15 +19561,23 @@ "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" }, - ", input: T) => Promise" + ", input: T) => ", + "Observable", + "" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 489 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Execution.interpret.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -17365,42 +19587,38 @@ "text": "ExpressionAstNode" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 - } + "lineNumber": 489 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Execution.interpret.$2", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 - } + "lineNumber": 489 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 70 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionContract", "type": "Class", "tags": [], @@ -17418,32 +19636,48 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExecutionContract.isPending", "type": "boolean", - "label": "isPending", "tags": [], + "label": "isPending", "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 18 - } + "lineNumber": 20 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionContract.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExecutionContract.Unnamed.$1", "type": "Object", + "tags": [], "label": "execution", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -17454,42 +19688,45 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 24 - } + "lineNumber": 26 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 24 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionContract.cancel", "type": "Function", - "children": [], - "signature": [ - "() => void" - ], + "tags": [], + "label": "cancel", "description": [ "\nCancel the execution of the expression. This will set abort signal\n(available in execution context) to aborted state, letting expression\nfunctions to stop their execution." ], - "label": "cancel", + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 31 + "lineNumber": 33 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionContract.getData", "type": "Function", - "children": [], + "tags": [], + "label": "getData", + "description": [ + "\nReturns the final output of expression, if any error happens still\nwraps that error into `ExpressionValueError` type and returns that.\nThis function never throws." + ], "signature": [ "() => Promise<", { @@ -17517,39 +19754,43 @@ }, " | undefined; }> | Output>" ], - "description": [ - "\nReturns the final output of expression, if any error happens still\nwraps that error into `ExpressionValueError` type and returns that.\nThis function never throws." - ], - "label": "getData", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 40 + "lineNumber": 42 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionContract.getExpression", "type": "Function", - "children": [], - "signature": [ - "() => string" - ], + "tags": [], + "label": "getExpression", "description": [ "\nGet string representation of the expression. Returns the original string\nif execution was started from a string. If execution was started from an\nAST this method returns a string generated from AST." ], - "label": "getExpression", + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 60 + "lineNumber": 65 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionContract.getAst", "type": "Function", - "children": [], + "tags": [], + "label": "getAst", + "description": [ + "\nGet AST used to execute the expression." + ], "signature": [ "() => ", { @@ -17560,43 +19801,39 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "\nGet AST used to execute the expression." - ], - "label": "getAst", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 67 + "lineNumber": 72 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionContract.inspect", "type": "Function", - "children": [], - "signature": [ - "() => InspectorAdapters" - ], + "tags": [], + "label": "inspect", "description": [ "\nGet Inspector adapters provided to all functions of expression through\nexecution context." ], - "label": "inspect", + "signature": [ + "() => InspectorAdapters" + ], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 73 + "lineNumber": 78 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.Executor", "type": "Class", "tags": [], @@ -17628,11 +19865,19 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 81 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.createWithDefaults", "type": "Function", + "tags": [], "label": "createWithDefaults", + "description": [], "signature": [ "typeof ", { @@ -17644,13 +19889,19 @@ }, ".createWithDefaults" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.createWithDefaults.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "expressions", @@ -17661,30 +19912,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 83 - } + "lineNumber": 84 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 82 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Executor.state", "type": "Object", + "tags": [], "label": "state", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 91 - }, "signature": [ { "pluginId": "expressions", @@ -17694,20 +19938,22 @@ "text": "ExecutorContainer" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 92 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.Executor.functions", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-common.Executor.functions", - "type": "Object", "label": "functions", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 96 - }, "signature": [ { "pluginId": "expressions", @@ -17716,20 +19962,23 @@ "section": "def-common.FunctionsRegistry", "text": "FunctionsRegistry" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 97 + }, + "deprecated": true, + "references": [] }, { + "parentPluginId": "expressions", + "id": "def-common.Executor.types", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-common.Executor.types", - "type": "Object", "label": "types", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 101 - }, "signature": [ { "pluginId": "expressions", @@ -17738,22 +19987,37 @@ "section": "def-common.TypesRegistry", "text": "TypesRegistry" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 102 + }, + "deprecated": true, + "references": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.Unnamed.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "expressions", @@ -17764,24 +20028,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 - } + "lineNumber": 104 + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.registerFunction", "type": "Function", + "tags": [], "label": "registerFunction", + "description": [], "signature": [ "(functionDefinition: ", { @@ -17801,13 +20064,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 110 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.registerFunction.$1", "type": "CompoundType", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -17826,24 +20095,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 110 - } + "lineNumber": 111 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 109 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.getFunction", "type": "Function", + "tags": [], "label": "getFunction", + "description": [], "signature": [ "(name: string) => ", { @@ -17855,34 +20123,39 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 119 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.getFunction.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 - } + "lineNumber": 119 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.getFunctions", "type": "Function", + "tags": [], "label": "getFunctions", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 122 - } + "lineNumber": 123 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.registerType", "type": "Function", + "tags": [], "label": "registerType", + "description": [], "signature": [ "(typeDefinition: ", { @@ -17926,13 +20201,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 127 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.registerType.$1", "type": "CompoundType", + "tags": [], "label": "typeDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -17951,24 +20232,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 127 - } + "lineNumber": 128 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 126 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.getType", "type": "Function", + "tags": [], "label": "getType", + "description": [], "signature": [ "(name: string) => ", { @@ -17980,34 +20260,39 @@ }, " | undefined" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 136 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.getType.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 - } + "lineNumber": 136 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.getTypes", "type": "Function", + "tags": [], "label": "getTypes", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 139 - } + "lineNumber": 140 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.extendContext", "type": "Function", + "tags": [], "label": "extendContext", + "description": [], "signature": [ "(extraContext: Record) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 144 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.extendContext.$1", "type": "Object", + "tags": [], "label": "extraContext", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 - } + "lineNumber": 144 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.context", "type": "Object", - "label": "context", "tags": [], + "label": "context", "description": [], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 147 + "lineNumber": 148 }, - "signature": [ - "Record" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.Executor.run", "type": "Function", + "tags": [], "label": "run", + "description": [ + "\nExecute expression and return result.\n" + ], "signature": [ "(ast: string | ", { @@ -18094,17 +20390,40 @@ "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, - ") => Promise" - ], - "description": [ - "\nExecute expression and return result.\n" + ") => ", + "Observable", + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"error\", { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + } ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 160 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.run.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [ + "Expression AST or a string representing expression." + ], "signature": [ "string | ", { @@ -18115,35 +20434,39 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "Expression AST or a string representing expression." - ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 160 - } + "lineNumber": 161 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Executor.run.$2", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, - "signature": [ - "Input" - ], "description": [ "Initial input to the first expression function." ], + "signature": [ + "Input" + ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 161 - } + "lineNumber": 162 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Executor.run.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -18153,24 +20476,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 162 - } + "lineNumber": 163 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 159 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.createExecution", "type": "Function", + "tags": [], "label": "createExecution", + "description": [], "signature": [ "(ast: string | ", { @@ -18206,13 +20528,19 @@ }, ">" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 168 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.createExecution.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ "string | ", { @@ -18223,17 +20551,20 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 170 - } + "lineNumber": 169 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Executor.createExecution.$2", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -18243,24 +20574,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 171 - } + "lineNumber": 170 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 169 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.inject", "type": "Function", + "tags": [], "label": "inject", + "description": [], "signature": [ "(ast: ", { @@ -18281,13 +20611,19 @@ "text": "ExpressionAstExpression" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 216 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.inject.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -18297,39 +20633,41 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 - } + "lineNumber": 216 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Executor.inject.$2", "type": "Array", + "tags": [], "label": "references", - "isRequired": true, + "description": [], "signature": [ "SavedObjectReference", "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 - } + "lineNumber": 216 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.extract", "type": "Function", + "tags": [], "label": "extract", + "description": [], "signature": [ "(ast: ", { @@ -18351,13 +20689,19 @@ "SavedObjectReference", "[]; }" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 229 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.extract.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -18367,24 +20711,23 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 - } + "lineNumber": 229 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.telemetry", "type": "Function", + "tags": [], "label": "telemetry", + "description": [], "signature": [ "(ast: ", { @@ -18396,13 +20739,19 @@ }, ", telemetryData: Record) => Record" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 240 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.telemetry.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -18412,38 +20761,40 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 - } + "lineNumber": 240 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Executor.telemetry.$2", "type": "Object", + "tags": [], "label": "telemetryData", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 - } + "lineNumber": 240 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.migrate", "type": "Function", + "tags": [], "label": "migrate", + "description": [], "signature": [ "(ast: ", { @@ -18462,13 +20813,19 @@ "text": "ExpressionAstExpression" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 248 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.Executor.migrate.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -18478,38 +20835,40 @@ "text": "SerializableState" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 - } + "lineNumber": 248 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Executor.migrate.$2", "type": "string", + "tags": [], "label": "version", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 - } + "lineNumber": 248 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.fork", "type": "Function", + "tags": [], "label": "fork", + "description": [], "signature": [ "() => ", { @@ -18521,23 +20880,19 @@ }, "" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 258 - } + "lineNumber": 257 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 80 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction", "type": "Class", "tags": [], @@ -18569,129 +20924,147 @@ }, "[]>>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nName of function" ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 22 - } + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [ "\nAliases that can be used instead of `name`." ], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 27 + "lineNumber": 26 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future." ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 34 - } + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.fn", "type": "Function", + "tags": [], "label": "fn", "description": [ "\nFunction to run function (context, args)" ], + "signature": [ + "(input: any, params: Record, handlers: object) => any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 39 + "lineNumber": 38 }, - "signature": [ - "(input: any, params: Record, handlers: object) => any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nA short help text." ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 44 - } + "lineNumber": 43 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.args", "type": "Object", "tags": [], - "children": [], + "label": "args", "description": [ "\nSpecification of expression function parameters." ], - "label": "args", "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 49 - } + "lineNumber": 48 + }, + "deprecated": false, + "children": [] }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [ "\nType of inputs that this function supports." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 54 + "lineNumber": 53 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.disabled", "type": "boolean", + "tags": [], "label": "disabled", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 56 - } + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.telemetry", "type": "Function", + "tags": [], "label": "telemetry", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 57 - }, "signature": [ "(state: Record, telemetryData: Record) => Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.extract", "type": "Function", + "tags": [], "label": "extract", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 61 - }, "signature": [ "(state: Record; references: ", "SavedObjectReference", "[]; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 60 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.inject", "type": "Function", + "tags": [], "label": "inject", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 64 - }, "signature": [ "(state: Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 63 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.migrations", "type": "Object", + "tags": [], "label": "migrations", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 68 - }, "signature": [ "{ [key: string]: (state: ", { @@ -18796,22 +21175,36 @@ "text": "SerializableState" }, "; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 67 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.Unnamed.$1", "type": "Object", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -18821,204 +21214,237 @@ "text": "AnyExpressionFunctionDefinition" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 72 - } + "lineNumber": 71 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 72 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.accepts", "type": "Function", + "tags": [], + "label": "accepts", + "description": [], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 105 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.accepts.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 107 - } + "lineNumber": 105 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(type: string) => boolean" - ], - "description": [], - "label": "accepts", - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 107 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter", "type": "Class", "tags": [], "label": "ExpressionFunctionParameter", "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.required", "type": "boolean", + "tags": [], "label": "required", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 15 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.default", "type": "Any", + "tags": [], "label": "default", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 16 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 17 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.multi", "type": "boolean", + "tags": [], "label": "multi", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.resolve", "type": "boolean", + "tags": [], "label": "resolve", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.options", "type": "Array", + "tags": [], "label": "options", "description": [], + "signature": [ + "any[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 20 }, - "signature": [ - "any[]" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.Unnamed.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.Unnamed.$2", "type": "CompoundType", + "tags": [], "label": "arg", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -19029,59 +21455,57 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", - "lineNumber": 22 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.accepts", "type": "Function", + "tags": [], "label": "accepts", + "description": [], "signature": [ "(type: string) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.accepts.$1", "type": "string", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "lineNumber": 40 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", - "lineNumber": 40 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer", "type": "Class", "tags": [], @@ -19097,75 +21521,87 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.validate", "type": "Function", + "tags": [], "label": "validate", "description": [], + "signature": [ + "() => void | Error" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 15 }, - "signature": [ - "() => void | Error" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.reuseDomNode", "type": "boolean", + "tags": [], "label": "reuseDomNode", "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.render", "type": "Function", + "tags": [], "label": "render", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", - "lineNumber": 17 - }, "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { @@ -19176,22 +21612,36 @@ "text": "IInterpreterRenderHandlers" }, ") => void | Promise" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 17 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -19202,28 +21652,21 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", - "lineNumber": 19 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry", "type": "Class", "tags": [], @@ -19255,11 +21698,19 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(definition: ", { @@ -19279,13 +21730,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.register.$1", "type": "CompoundType", + "tags": [], "label": "definition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -19304,24 +21761,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", - "lineNumber": 19 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -19333,34 +21789,39 @@ }, " | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", - "lineNumber": 25 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record>" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -19396,23 +21859,19 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsInspectorAdapter", "type": "Class", "tags": [], @@ -19429,60 +21888,69 @@ " extends ", "EventEmitter" ], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsInspectorAdapter.logAST", "type": "Function", + "tags": [], "label": "logAST", + "description": [], "signature": [ "(ast: any) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsInspectorAdapter.logAST.$1", "type": "Any", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", - "lineNumber": 14 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsInspectorAdapter.ast", "type": "Any", - "label": "ast", "tags": [], + "label": "ast", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", "lineNumber": 19 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService", "type": "Class", "tags": [], @@ -19516,17 +21984,19 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 175 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.executor", "type": "Object", + "tags": [], "label": "executor", "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 175 - }, "signature": [ { "pluginId": "expressions", @@ -19536,18 +22006,20 @@ "text": "Executor" }, ">" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 176 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.renderers", "type": "Object", + "tags": [], "label": "renderers", "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 176 - }, "signature": [ { "pluginId": "expressions", @@ -19556,22 +22028,36 @@ "section": "def-common.ExpressionRendererRegistry", "text": "ExpressionRendererRegistry" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 177 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 179 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.Unnamed.$1", "type": "Object", + "tags": [], "label": "{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -19581,29 +22067,57 @@ "text": "ExpressionServiceParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 178 - } + "lineNumber": 179 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 178 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.registerFunction", "type": "Function", + "tags": [], + "label": "registerFunction", + "description": [ + "\nRegister an expression function, which will be possible to execute as\npart of the expression pipeline.\n\nBelow we register a function which simply sleeps for given number of\nmilliseconds to delay the execution and outputs its input as-is.\n\n```ts\nexpressions.registerFunction({\n name: 'sleep',\n args: {\n time: {\n aliases: ['_'],\n help: 'Time in milliseconds for how long to sleep',\n types: ['number'],\n },\n },\n help: '',\n fn: async (input, args, context) => {\n await new Promise(r => setTimeout(r, args.time));\n return input;\n },\n}\n```\n\nThe actual function is defined in the `fn` key. The function can be *async*.\nIt receives three arguments: (1) `input` is the output of the previous function\nor the initial input of the expression if the function is first in chain;\n(2) `args` are function arguments as defined in expression string, that can\nbe edited by user (e.g in case of Canvas); (3) `context` is a shared object\npassed to all functions that can be used for side-effects." + ], + "signature": [ + "(functionDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")) => void" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 219 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.registerFunction.$1", "type": "CompoundType", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -19622,52 +22136,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 219 - } + "lineNumber": 220 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.registerType", + "type": "Function", + "tags": [], + "label": "registerType", + "description": [], "signature": [ - "(functionDefinition: ", + "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" }, ")) => void" ], - "description": [ - "\nRegister an expression function, which will be possible to execute as\npart of the expression pipeline.\n\nBelow we register a function which simply sleeps for given number of\nmilliseconds to delay the execution and outputs its input as-is.\n\n```ts\nexpressions.registerFunction({\n name: 'sleep',\n args: {\n time: {\n aliases: ['_'],\n help: 'Time in milliseconds for how long to sleep',\n types: ['number'],\n },\n },\n help: '',\n fn: async (input, args, context) => {\n await new Promise(r => setTimeout(r, args.time));\n return input;\n },\n}\n```\n\nThe actual function is defined in the `fn` key. The function can be *async*.\nIt receives three arguments: (1) `input` is the output of the previous function\nor the initial input of the expression if the function is first in chain;\n(2) `args` are function arguments as defined in expression string, that can\nbe edited by user (e.g in case of Canvas); (3) `context` is a shared object\npassed to all functions that can be used for side-effects." - ], - "label": "registerFunction", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 218 + "lineNumber": 223 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.ExpressionsService.registerType", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.registerType.$1", "type": "CompoundType", + "tags": [], "label": "typeDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -19686,50 +22203,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 223 - } + "lineNumber": 224 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.registerRenderer", + "type": "Function", + "tags": [], + "label": "registerRenderer", + "description": [], "signature": [ - "(typeDefinition: ", + "(definition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" }, ")) => void" ], - "description": [], - "label": "registerType", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 222 + "lineNumber": 227 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.ExpressionsService.registerRenderer", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.registerRenderer.$1", "type": "CompoundType", + "tags": [], "label": "definition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -19748,50 +22270,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 227 - } + "lineNumber": 228 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.run", + "type": "Function", + "tags": [], + "label": "run", + "description": [], "signature": [ - "(definition: ", + "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionRenderDefinition", - "text": "AnyExpressionRenderDefinition" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | (() => ", + ", input: Input, params: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionRenderDefinition", - "text": "AnyExpressionRenderDefinition" + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" }, - ")) => void" + " | undefined) => Promise" ], - "description": [], - "label": "registerRenderer", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 226 + "lineNumber": 231 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.ExpressionsService.run", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.run.$1", "type": "CompoundType", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ "string | ", { @@ -19802,31 +22329,37 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 230 - } + "lineNumber": 231 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.run.$2", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "Input" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 230 - } + "lineNumber": 231 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.run.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "expressions", @@ -19837,84 +22370,69 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 230 - } + "lineNumber": 231 + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.getFunction", + "type": "Function", + "tags": [], + "label": "getFunction", + "description": [], "signature": [ - "(ast: string | ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - }, - ", input: Input, params: ", + "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionExecutionParams", - "text": "ExpressionExecutionParams" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" }, - " | undefined) => Promise" + " | undefined" ], - "description": [], - "label": "run", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 230 + "lineNumber": 234 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.ExpressionsService.getFunction", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getFunction.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 233 - } + "lineNumber": 234 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(name: string) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" - }, - " | undefined" - ], - "description": [], - "label": "getFunction", - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 233 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getFunctions", "type": "Function", - "children": [], + "tags": [], + "label": "getFunctions", + "description": [ + "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." + ], "signature": [ "() => Record" ], - "description": [ - "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." - ], - "label": "getFunctions", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 240 + "lineNumber": 241 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getRenderer", "type": "Function", - "children": [ - { - "id": "def-common.ExpressionsService.getRenderer.$1", - "type": "string", - "label": "name", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 243 - } - } - ], + "tags": [], + "label": "getRenderer", + "description": [], "signature": [ "(name: string) => ", { @@ -19967,19 +22470,41 @@ }, " | null" ], - "description": [], - "label": "getRenderer", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 243 + "lineNumber": 244 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.getRenderer.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 244 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getRenderers", "type": "Function", - "children": [], + "tags": [], + "label": "getRenderers", + "description": [ + "\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances." + ], "signature": [ "() => Record>" ], - "description": [ - "\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances." - ], - "label": "getRenderers", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 250 + "lineNumber": 251 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getType", "type": "Function", - "children": [ - { - "id": "def-common.ExpressionsService.getType.$1", - "type": "string", - "label": "name", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 253 - } - } - ], + "tags": [], + "label": "getType", + "description": [], "signature": [ "(name: string) => ", { @@ -20032,19 +22542,41 @@ }, " | undefined" ], - "description": [], - "label": "getType", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 253 + "lineNumber": 254 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.getType.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 254 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getTypes", "type": "Function", - "children": [], + "tags": [], + "label": "getTypes", + "description": [ + "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." + ], "signature": [ "() => Record" ], - "description": [ - "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." - ], - "label": "getTypes", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 260 + "lineNumber": 261 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.execute", "type": "Function", + "tags": [], "label": "execute", "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 262 - }, "signature": [ "(ast: string | ", { @@ -20103,12 +22629,20 @@ "text": "ExecutionContract" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 263 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.fork", "type": "Function", - "children": [], + "tags": [], + "label": "fork", + "description": [], "signature": [ "() => ", { @@ -20119,24 +22653,47 @@ "text": "ExpressionsService" } ], - "description": [], - "label": "fork", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 268 + "lineNumber": 269 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.telemetry", "type": "Function", + "tags": [], + "label": "telemetry", + "description": [ + "\nExtracts telemetry from expression AST" + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", telemetryData?: Record) => Record" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 281 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.telemetry.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -20146,27 +22703,42 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 281 - } + "lineNumber": 282 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.telemetry.$2", "type": "Object", + "tags": [], "label": "telemetryData", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 282 - } + "lineNumber": 283 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.extract", + "type": "Function", + "tags": [], + "label": "extract", + "description": [ + "\nExtracts saved object references from expression AST" + ], "signature": [ "(state: ", { @@ -20176,28 +22748,31 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - ", telemetryData?: Record) => Record" + ") => { state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; references: ", + "SavedObjectReference", + "[]; }" ], - "description": [ - "\nExtracts telemetry from expression AST" - ], - "label": "telemetry", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 280 + "lineNumber": 293 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.ExpressionsService.extract", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.extract.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -20207,13 +22782,27 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 292 - } + "lineNumber": 293 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "new expression AST with references removed and array of references" + ] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.inject", + "type": "Function", + "tags": [], + "label": "inject", + "description": [ + "\nInjects saved object references into expression AST" + ], "signature": [ "(state: ", { @@ -20223,40 +22812,30 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - ") => { state: ", + ", references: ", + "SavedObjectReference", + "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" - }, - "; references: ", - "SavedObjectReference", - "[]; }" - ], - "description": [ - "\nExtracts saved object references from expression AST" + } ], - "label": "extract", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 292 + "lineNumber": 303 }, - "tags": [], - "returnComment": [ - "new expression AST with references removed and array of references" - ] - }, - { - "id": "def-common.ExpressionsService.inject", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.inject.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -20266,40 +22845,55 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 - } + "lineNumber": 303 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.inject.$2", "type": "Array", + "tags": [], "label": "references", - "isRequired": true, + "description": [], "signature": [ "SavedObjectReference", "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 - } + "lineNumber": 303 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [ + "new expression AST with references injected" + ] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.migrate", + "type": "Function", + "tags": [], + "label": "migrate", + "description": [ + "\nRuns the migration (if it exists) for specified version. This will run a single migration step (ie from 7.10.0 to 7.10.1)" + ], "signature": [ "(state: ", { - "pluginId": "expressions", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" }, - ", references: ", - "SavedObjectReference", - "[]) => ", + ", version: string) => ", { "pluginId": "expressions", "scope": "common", @@ -20308,28 +22902,19 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "\nInjects saved object references into expression AST" - ], - "label": "inject", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 + "lineNumber": 313 }, - "tags": [], - "returnComment": [ - "new expression AST with references injected" - ] - }, - { - "id": "def-common.ExpressionsService.migrate", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.migrate.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -20339,62 +22924,44 @@ "text": "SerializableState" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 - } + "lineNumber": 313 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.migrate.$2", "type": "string", + "tags": [], "label": "version", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 - } - } - ], - "signature": [ - "(state: ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, - ", version: string) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "lineNumber": 313 + }, + "deprecated": false, + "isRequired": true } ], - "description": [ - "\nRuns the migration (if it exists) for specified version. This will run a single migration step (ie from 7.10.0 to 7.10.1)" - ], - "label": "migrate", - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 - }, - "tags": [], "returnComment": [ "new migrated expression AST" ] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [ + "\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." + ], "signature": [ "() => Pick<", { @@ -20406,21 +22973,23 @@ }, ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], - "description": [ - "\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 320 - } + "lineNumber": 321 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.start", "type": "Function", + "tags": [], "label": "start", + "description": [ + "\nReturns Kibana Platform *start* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." + ], "signature": [ "() => ", { @@ -20431,62 +23000,66 @@ "text": "ExpressionsServiceStart" } ], - "description": [ - "\nReturns Kibana Platform *start* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." - ], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 328 - } + "lineNumber": 329 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 332 - } + "lineNumber": 333 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 174 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionType", "type": "Class", "tags": [], "label": "ExpressionType", "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionType.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionType.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nA short help text." @@ -20494,82 +23067,100 @@ "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionType.validate", "type": "Function", + "tags": [], "label": "validate", "description": [ "\nType validation, useful for checking function output." ], + "signature": [ + "(type: any) => void | Error" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 23 }, - "signature": [ - "(type: any) => void | Error" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionType.create", "type": "Unknown", + "tags": [], "label": "create", "description": [], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 25 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionType.serialize", "type": "Function", + "tags": [], "label": "serialize", "description": [ "\nOptional serialization (used when passing context around client/server)." ], + "signature": [ + "((value: any) => any) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 30 }, - "signature": [ - "((value: any) => any) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionType.deserialize", "type": "Function", + "tags": [], "label": "deserialize", "description": [], + "signature": [ + "((serialized: any) => any) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 31 }, - "signature": [ - "((serialized: any) => any) | undefined" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.Unnamed.$1", "type": "Object", + "tags": [], "label": "definition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -20579,39 +23170,23 @@ "text": "AnyExpressionTypeDefinition" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 33 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 33 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.getToFn", "type": "Function", - "children": [ - { - "id": "def-common.ExpressionType.getToFn.$1", - "type": "string", - "label": "typeName", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 48 - } - } - ], + "tags": [], + "label": "getToFn", + "description": [], "signature": [ "(typeName: string) => ", { @@ -20623,34 +23198,39 @@ }, " | undefined" ], - "description": [], - "label": "getToFn", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 47 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.ExpressionType.getFromFn", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.ExpressionType.getFromFn.$1", + "parentPluginId": "expressions", + "id": "def-common.ExpressionType.getToFn.$1", "type": "string", + "tags": [], "label": "typeName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 53 - } + "lineNumber": 48 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionType.getFromFn", + "type": "Function", + "tags": [], + "label": "getFromFn", + "description": [], "signature": [ "(typeName: string) => ", { @@ -20662,114 +23242,169 @@ }, " | undefined" ], - "description": [], - "label": "getFromFn", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 52 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionType.getFromFn.$1", + "type": "string", + "tags": [], + "label": "typeName", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 53 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.castsTo", "type": "Function", + "tags": [], + "label": "castsTo", + "description": [], + "signature": [ + "(value: any) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.castsTo.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionType.castsFrom", + "type": "Function", + "tags": [], + "label": "castsFrom", + "description": [], "signature": [ "(value: any) => boolean" ], - "description": [], - "label": "castsTo", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 57 + "lineNumber": 59 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.ExpressionType.castsFrom", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.castsFrom.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any) => boolean" - ], - "description": [], - "label": "castsFrom", - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 59 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.to", "type": "Function", + "tags": [], + "label": "to", + "description": [], + "signature": [ + "(value: any, toTypeName: string, types: Record) => any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.to.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.to.$2", "type": "string", + "tags": [], "label": "toTypeName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.to.$3", "type": "Object", + "tags": [], "label": "types", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionType.from", + "type": "Function", + "tags": [], + "label": "from", + "description": [], "signature": [ - "(value: any, toTypeName: string, types: Record) => any" ], - "description": [], - "label": "to", "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 61 + "lineNumber": 73 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.ExpressionType.from", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.from.$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 73 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionType.from.$2", "type": "Object", + "tags": [], "label": "types", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 73 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any, types: Record) => any" - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 73 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/expression_type.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry", "type": "Class", "tags": [], @@ -20908,21 +23531,35 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.Unnamed.$1", "type": "Object", + "tags": [], "label": "executor", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -20933,24 +23570,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 - } + "lineNumber": 60 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(functionDefinition: ", { @@ -20970,13 +23606,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.register.$1", "type": "CompoundType", + "tags": [], "label": "functionDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -20995,24 +23637,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 62 - } + "lineNumber": 63 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 61 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -21024,34 +23665,39 @@ }, " | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 68 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 67 - } + "lineNumber": 68 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 67 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 71 - } + "lineNumber": 72 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -21087,23 +23735,19 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 75 - } + "lineNumber": 76 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 58 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.TablesAdapter", "type": "Class", "tags": [], @@ -21120,11 +23764,19 @@ " extends ", "EventEmitter" ], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.TablesAdapter.logDatatable", "type": "Function", + "tags": [], "label": "logDatatable", + "description": [], "signature": [ "(name: string, datatable: ", { @@ -21136,27 +23788,36 @@ }, ") => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.TablesAdapter.logDatatable.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/util/tables_adapter.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.TablesAdapter.logDatatable.$2", "type": "Object", + "tags": [], "label": "datatable", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -21166,30 +23827,23 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/util/tables_adapter.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/util/tables_adapter.ts", - "lineNumber": 15 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.TablesAdapter.tables", "type": "Object", - "label": "tables", "tags": [], + "label": "tables", "description": [], - "source": { - "path": "src/plugins/expressions/common/util/tables_adapter.ts", - "lineNumber": 20 - }, "signature": [ "{ [key: string]: ", { @@ -21200,16 +23854,18 @@ "text": "Datatable" }, "; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 20 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/util/tables_adapter.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry", "type": "Class", "tags": [], @@ -21241,21 +23897,35 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.Unnamed.$1", "type": "Object", + "tags": [], "label": "executor", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -21266,24 +23936,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 - } + "lineNumber": 38 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(typeDefinition: ", { @@ -21303,13 +23972,19 @@ }, ")) => void" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.register.$1", "type": "CompoundType", + "tags": [], "label": "typeDefinition", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -21328,24 +24003,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 40 - } + "lineNumber": 41 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 39 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -21357,34 +24031,39 @@ }, " | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 45 - } + "lineNumber": 46 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 49 - } + "lineNumber": 50 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -21420,28 +24101,30 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 53 - } + "lineNumber": 54 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 36 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "expressions", "id": "def-common.buildExpression", "type": "Function", + "tags": [ + "return" + ], "label": "buildExpression", + "description": [ + "\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n" + ], "signature": [ "(initialState: string | ", { @@ -21476,15 +24159,21 @@ "text": "ExpressionAstExpressionBuilder" } ], - "description": [ - "\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 97 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.buildExpression.$1", "type": "CompoundType", + "tags": [], "label": "initialState", - "isRequired": false, + "description": [ + "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." + ], "signature": [ "string | ", { @@ -21512,31 +24201,30 @@ }, ">[] | undefined" ], - "description": [ - "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." - ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 98 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "return" - ], "returnComment": [ "`this`" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 97 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.buildExpressionFunction", "type": "Function", + "tags": [ + "return" + ], "label": "buildExpressionFunction", + "description": [ + "\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n" + ], "signature": [ "(fnName: ", { @@ -21572,15 +24260,21 @@ }, "" ], - "description": [ - "\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 152 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.buildExpressionFunction.$1", "type": "Uncategorized", + "tags": [], "label": "fnName", - "isRequired": true, + "description": [ + "String representing the name of this expression function." + ], "signature": [ { "pluginId": "expressions", @@ -21591,19 +24285,22 @@ }, "[\"name\"]" ], - "description": [ - "String representing the name of this expression function." - ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 155 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.buildExpressionFunction.$2", "type": "Object", + "tags": [], "label": "initialArgs", - "isRequired": true, + "description": [ + "Object containing the arguments to this function." + ], "signature": [ "{ [K in keyof FunctionArgs]: FunctionArgs[K] | ", { @@ -21623,31 +24320,28 @@ }, "[]; }" ], - "description": [ - "Object containing the arguments to this function." - ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 163 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "`this`" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 152 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.buildResultColumns", "type": "Function", + "tags": [], "label": "buildResultColumns", + "description": [ + "\nChecks whether input and output columns are defined properly\nand builds column array of the output table if that's the case.\n\n* Throws an error if the output column exists already.\n* Returns undefined if the input column doesn't exist." + ], "signature": [ "(input: ", { @@ -21667,15 +24361,21 @@ }, "[] | undefined" ], - "description": [ - "\nChecks whether input and output columns are defined properly\nand builds column array of the output table if that's the case.\n\n* Throws an error if the output column exists already.\n* Returns undefined if the input column doesn't exist." - ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$1", "type": "Object", + "tags": [], "label": "input", - "isRequired": true, + "description": [ + "Input datatable" + ], "signature": [ { "pluginId": "expressions", @@ -21685,121 +24385,109 @@ "text": "Datatable" } ], - "description": [ - "Input datatable" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$2", "type": "string", + "tags": [], "label": "outputColumnId", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Id of the output column" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$3", "type": "string", + "tags": [], "label": "inputColumnId", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Id of the input column" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$4", "type": "string", + "tags": [], "label": "outputColumnName", - "isRequired": false, - "signature": [ - "string | undefined" - ], "description": [ "Optional name of the output column" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "lineNumber": 37 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$5.options", "type": "Object", - "label": "options", "tags": [], + "label": "options", "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$5.options.allowColumnOverwrite", "type": "boolean", + "tags": [], "label": "allowColumnOverwrite", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "lineNumber": 38 - } + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", - "lineNumber": 38 - } + ] } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", - "lineNumber": 33 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.createError", "type": "Function", - "children": [ - { - "id": "def-common.createError.$1", - "type": "CompoundType", - "label": "err", - "isRequired": true, - "signature": [ - "string | ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ErrorLike", - "text": "ErrorLike" - } - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/util/create_error.ts", - "lineNumber": 21 - } - } - ], + "tags": [], + "label": "createError", + "description": [], "signature": [ "(err: string | ", { @@ -21835,42 +24523,47 @@ }, " | undefined; }>" ], - "description": [], - "label": "createError", "source": { "path": "src/plugins/expressions/common/util/create_error.ts", "lineNumber": 21 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.createExecutionContainer", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.createExecutionContainer.$1", - "type": "Object", - "label": "state", - "isRequired": true, + "parentPluginId": "expressions", + "id": "def-common.createError.$1", + "type": "CompoundType", + "tags": [], + "label": "err", + "description": [], "signature": [ + "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" - }, - "" + "section": "def-common.ErrorLike", + "text": "ErrorLike" + } ], - "description": [], "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 81 - } + "path": "src/plugins/expressions/common/util/create_error.ts", + "lineNumber": 21 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.createExecutionContainer", + "type": "Function", + "tags": [], + "label": "createExecutionContainer", + "description": [], "signature": [ "(state?: ", { @@ -21890,42 +24583,47 @@ }, "" ], - "description": [], - "label": "createExecutionContainer", "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 80 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.createExecutorContainer", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.createExecutorContainer.$1", + "parentPluginId": "expressions", + "id": "def-common.createExecutionContainer.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" + "section": "def-common.ExecutionState", + "text": "ExecutionState" }, - "" + "" ], - "description": [], "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 62 - } + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 81 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.createExecutorContainer", + "type": "Function", + "tags": [], + "label": "createExecutorContainer", + "description": [], "signature": [ " = Record>(state?: ", { @@ -21945,20 +24643,47 @@ }, "" ], - "description": [], - "label": "createExecutorContainer", "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 59 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.createExecutorContainer.$1", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + "" + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 62 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.createMockContext", "type": "Function", - "children": [], + "tags": [], + "label": "createMockContext", + "description": [], "signature": [ "() => ", { @@ -21980,20 +24705,22 @@ "SerializableState", ">" ], - "description": [], - "label": "createMockContext", "source": { "path": "src/plugins/expressions/common/util/test_utils.ts", "lineNumber": 11 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.format", "type": "Function", + "tags": [], "label": "format", + "description": [], "signature": [ "(ast: T, type: T extends ", { @@ -22005,27 +24732,36 @@ }, " ? \"expression\" : \"argument\") => string" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.format.$1", "type": "Uncategorized", + "tags": [], "label": "ast", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/format.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.format.$2", "type": "Uncategorized", + "tags": [], "label": "type", - "isRequired": true, + "description": [], "signature": [ "T extends ", { @@ -22037,25 +24773,26 @@ }, " ? \"expression\" : \"argument\"" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/format.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/format.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.formatExpression", "type": "Function", + "tags": [], "label": "formatExpression", + "description": [ + "\nGiven expression pipeline AST, returns formatted string.\n" + ], "signature": [ "(ast: ", { @@ -22067,15 +24804,21 @@ }, ") => string" ], - "description": [ - "\nGiven expression pipeline AST, returns formatted string.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.formatExpression.$1", "type": "Object", + "tags": [], "label": "ast", - "isRequired": true, + "description": [ + "Expression pipeline AST." + ], "signature": [ { "pluginId": "expressions", @@ -22085,169 +24828,174 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "Expression pipeline AST." - ], "source": { "path": "src/plugins/expressions/common/ast/format_expression.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/format_expression.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.getBucketIdentifier", "type": "Function", + "tags": [], "label": "getBucketIdentifier", - "signature": [ - "(row: Record, groupColumns: string[] | undefined) => string" - ], "description": [ "\nReturns a string identifying the group of a row by a list of columns to group by" ], + "signature": [ + "(row: Record, groupColumns: string[] | undefined) => string" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.getBucketIdentifier.$1", "type": "Object", + "tags": [], "label": "row", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.getBucketIdentifier.$2", "type": "Array", + "tags": [], "label": "groupColumns", - "isRequired": false, + "description": [], "signature": [ "string[] | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.getByAlias", "type": "Function", + "tags": [], "label": "getByAlias", - "signature": [ - "(node: T[] | Record, nodeName: string) => T | undefined" - ], "description": [ "\nThis is used for looking up function/argument definitions. It looks through\nthe given object/array for a case-insensitive match, which could be either the\n`name` itself, or something under the `aliases` property." ], + "signature": [ + "(node: T[] | Record, nodeName: string) => T | undefined" + ], + "source": { + "path": "src/plugins/expressions/common/util/get_by_alias.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.getByAlias.$1", "type": "CompoundType", + "tags": [], "label": "node", - "isRequired": true, + "description": [], "signature": [ "T[] | Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/util/get_by_alias.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.getByAlias.$2", "type": "string", + "tags": [], "label": "nodeName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/util/get_by_alias.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/util/get_by_alias.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.getType", "type": "Function", + "tags": [], "label": "getType", + "description": [], "signature": [ "(node: any) => any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/get_type.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.getType.$1", "type": "Any", + "tags": [], "label": "node", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/get_type.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/get_type.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.isDatatable", "type": "Function", - "children": [ - { - "id": "def-common.isDatatable.$1", - "type": "Unknown", - "label": "datatable", - "isRequired": true, - "signature": [ - "unknown" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 29 - } - } + "tags": [], + "label": "isDatatable", + "description": [ + "\nA Utility function that Typescript can use to determine if an object is a Datatable." ], "signature": [ "(datatable: unknown) => datatable is ", @@ -22259,77 +25007,85 @@ "text": "Datatable" } ], - "description": [ - "\nA Utility function that Typescript can use to determine if an object is a Datatable." - ], - "label": "isDatatable", "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 29 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.isDatatable.$1", + "type": "Unknown", + "tags": [], + "label": "datatable", + "description": [], + "signature": [ + "unknown" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 29 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.isExpressionAstBuilder", "type": "Function", - "label": "isExpressionAstBuilder", - "signature": [ - "(val: any) => boolean" + "tags": [ + "return" ], + "label": "isExpressionAstBuilder", "description": [ "\nType guard that checks whether a given value is an\n`ExpressionAstExpressionBuilder`. This is useful when working\nwith subexpressions, where you might be retrieving a function\nargument, and need to know whether it is an expression builder\ninstance which you can perform operations on.\n" ], + "signature": [ + "(val: any) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.isExpressionAstBuilder.$1", "type": "Any", + "tags": [], "label": "val", - "isRequired": true, - "signature": [ - "any" - ], "description": [ "Value you want to check." ], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "boolean" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.isExpressionValueError", "type": "Function", - "children": [ - { - "id": "def-common.isExpressionValueError.$1", - "type": "Any", - "label": "value", - "isRequired": true, - "signature": [ - "any" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/error.ts", - "lineNumber": 25 - } - } - ], + "tags": [], + "label": "isExpressionValueError", + "description": [], "signature": [ "(value: any) => value is ", { @@ -22357,20 +25113,40 @@ }, " | undefined; }>" ], - "description": [], - "label": "isExpressionValueError", "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "lineNumber": 25 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.isExpressionValueError.$1", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 25 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.parse", "type": "Function", + "tags": [], "label": "parse", + "description": [], "signature": [ "(expression: E, startRule: S) => S extends \"expression\" ? ", { @@ -22389,49 +25165,59 @@ "text": "ExpressionAstArgument" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.parse.$1", "type": "Uncategorized", + "tags": [], "label": "expression", - "isRequired": true, + "description": [], "signature": [ "E" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/parse.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.parse.$2", "type": "Uncategorized", + "tags": [], "label": "startRule", - "isRequired": true, + "description": [], "signature": [ "S" ], - "description": [], "source": { "path": "src/plugins/expressions/common/ast/parse.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/parse.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.parseExpression", "type": "Function", + "tags": [], "label": "parseExpression", + "description": [ + "\nGiven expression pipeline string, returns parsed AST.\n" + ], "signature": [ "(expression: string) => ", { @@ -22442,44 +25228,66 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "\nGiven expression pipeline string, returns parsed AST.\n" - ], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.parseExpression.$1", "type": "string", + "tags": [], "label": "expression", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "Expression pipeline string." ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/expressions/common/ast/parse_expression.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/ast/parse_expression.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.serializeProvider", "type": "Function", + "tags": [], + "label": "serializeProvider", + "description": [], + "signature": [ + "(types: Record) => { serialize: (value: any) => any; deserialize: (value: any) => any; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/serialize_provider.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.serializeProvider.$1", "type": "Object", + "tags": [], "label": "types", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/serialize_provider.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(types: Record) => { serialize: (value: any) => any; deserialize: (value: any) => any; }" - ], - "description": [], - "label": "serializeProvider", - "source": { - "path": "src/plugins/expressions/common/expression_types/serialize_provider.ts", - "lineNumber": 15 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.unboxExpressionValue", "type": "Function", + "tags": [], "label": "unboxExpressionValue", + "description": [], "signature": [ "({\n type,\n ...value\n}: ", { @@ -22534,13 +25328,19 @@ }, ") => T" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/unbox_expression_value.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.unboxExpressionValue.$1", "type": "CompoundType", + "tags": [], "label": "{\n type,\n ...value\n}", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -22551,112 +25351,121 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/unbox_expression_value.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/unbox_expression_value.ts", - "lineNumber": 11 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "expressions", "id": "def-common.ContainerStyle", "type": "Interface", + "tags": [], "label": "ContainerStyle", "description": [ "\nRepresents an object containing style information for a Container." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 105 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ContainerStyle.border", "type": "CompoundType", + "tags": [], "label": "border", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 106 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ContainerStyle.borderRadius", "type": "CompoundType", + "tags": [], "label": "borderRadius", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 107 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ContainerStyle.padding", "type": "CompoundType", + "tags": [], "label": "padding", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 108 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ContainerStyle.backgroundColor", "type": "CompoundType", + "tags": [], "label": "backgroundColor", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 109 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ContainerStyle.backgroundImage", "type": "CompoundType", + "tags": [], "label": "backgroundImage", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 110 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ContainerStyle.backgroundSize", "type": "Enum", + "tags": [], "label": "backgroundSize", "description": [], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 111 - }, "signature": [ { "pluginId": "expressions", @@ -22665,18 +25474,20 @@ "section": "def-common.BackgroundSize", "text": "BackgroundSize" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 111 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ContainerStyle.backgroundRepeat", "type": "Enum", + "tags": [], "label": "backgroundRepeat", "description": [], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 112 - }, "signature": [ { "pluginId": "expressions", @@ -22685,32 +25496,36 @@ "section": "def-common.BackgroundRepeat", "text": "BackgroundRepeat" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 112 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ContainerStyle.opacity", "type": "CompoundType", + "tags": [], "label": "opacity", "description": [], + "signature": [ + "number | null" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 113 }, - "signature": [ - "number | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ContainerStyle.overflow", "type": "Enum", + "tags": [], "label": "overflow", "description": [], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 114 - }, "signature": [ { "pluginId": "expressions", @@ -22719,90 +25534,102 @@ "section": "def-common.Overflow", "text": "Overflow" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 114 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 105 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.CSSStyle", "type": "Interface", + "tags": [], "label": "CSSStyle", "description": [ "\nRepresents the various style properties that can be applied to an element." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 90 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CSSStyle.color", "type": "string", + "tags": [], "label": "color", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 91 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CSSStyle.fill", "type": "string", + "tags": [], "label": "fill", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 92 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CSSStyle.fontFamily", "type": "CompoundType", + "tags": [], "label": "fontFamily", "description": [], + "signature": [ + "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\" | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 93 }, - "signature": [ - "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CSSStyle.fontSize", "type": "string", + "tags": [], "label": "fontSize", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 94 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CSSStyle.fontStyle", "type": "CompoundType", + "tags": [], "label": "fontStyle", "description": [], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 95 - }, "signature": [ { "pluginId": "expressions", @@ -22812,18 +25639,20 @@ "text": "FontStyle" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 95 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CSSStyle.fontWeight", "type": "CompoundType", + "tags": [], "label": "fontWeight", "description": [], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 96 - }, "signature": [ { "pluginId": "expressions", @@ -22833,32 +25662,36 @@ "text": "FontWeight" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 96 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CSSStyle.lineHeight", "type": "CompoundType", + "tags": [], "label": "lineHeight", "description": [], + "signature": [ + "string | number | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 97 }, - "signature": [ - "string | number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CSSStyle.textAlign", "type": "CompoundType", + "tags": [], "label": "textAlign", "description": [], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 98 - }, "signature": [ { "pluginId": "expressions", @@ -22868,18 +25701,20 @@ "text": "TextAlignment" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 98 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CSSStyle.textDecoration", "type": "CompoundType", + "tags": [], "label": "textDecoration", "description": [], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 99 - }, "signature": [ { "pluginId": "expressions", @@ -22889,112 +25724,128 @@ "text": "TextDecoration" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 99 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 90 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.CumulativeSumArgs", "type": "Interface", + "tags": [], "label": "CumulativeSumArgs", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CumulativeSumArgs.by", "type": "Array", + "tags": [], "label": "by", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 15 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CumulativeSumArgs.inputColumnId", "type": "string", + "tags": [], "label": "inputColumnId", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CumulativeSumArgs.outputColumnId", "type": "string", + "tags": [], "label": "outputColumnId", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.CumulativeSumArgs.outputColumnName", "type": "string", + "tags": [], "label": "outputColumnName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.Datatable", "type": "Interface", + "tags": [], "label": "Datatable", "description": [ "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Datatable.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"datatable\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 99 }, - "signature": [ - "\"datatable\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Datatable.columns", "type": "Array", + "tags": [], "label": "columns", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 100 - }, "signature": [ { "pluginId": "expressions", @@ -23004,70 +25855,80 @@ "text": "DatatableColumn" }, "[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 100 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Datatable.rows", "type": "Array", + "tags": [], "label": "rows", "description": [], + "signature": [ + "Record[]" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 101 }, - "signature": [ - "Record[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 98 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.DatatableColumn", "type": "Interface", + "tags": [], "label": "DatatableColumn", "description": [ "\nThis type represents the shape of a column in a `Datatable`." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 89 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DatatableColumn.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 90 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DatatableColumn.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 91 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DatatableColumn.meta", "type": "Object", + "tags": [], "label": "meta", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 92 - }, "signature": [ { "pluginId": "expressions", @@ -23076,34 +25937,38 @@ "section": "def-common.DatatableColumnMeta", "text": "DatatableColumnMeta" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 92 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 89 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta", "type": "Interface", + "tags": [], "label": "DatatableColumnMeta", "description": [ "\nDatatable column meta information" ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 63 - }, "signature": [ { "pluginId": "expressions", @@ -23112,52 +25977,58 @@ "section": "def-common.DatatableColumnType", "text": "DatatableColumnType" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 63 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.field", "type": "string", + "tags": [], "label": "field", "description": [ "\nfield this column is based on" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 67 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.index", "type": "string", + "tags": [], "label": "index", "description": [ "\nindex/table this column is based on" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 71 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.params", "type": "Object", + "tags": [], "label": "params", "description": [ "\nserialized field format" ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 75 - }, "signature": [ { "pluginId": "expressions", @@ -23167,52 +26038,62 @@ "text": "SerializedFieldFormat" }, "> | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 75 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.source", "type": "string", + "tags": [], "label": "source", "description": [ "\nsource function that produced this column" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 79 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.sourceParams", "type": "Object", + "tags": [], "label": "sourceParams", "description": [ "\nany extra parameters for the source that produced this column" ], + "signature": [ + "SerializableState", + " | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 83 }, - "signature": [ - "SerializableState", - " | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 62 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.DefaultInspectorAdapters", "type": "Interface", + "tags": [], "label": "DefaultInspectorAdapters", + "description": [ + "\nDefault inspector adapters created if inspector adapters are not set explicitly." + ], "signature": [ { "pluginId": "expressions", @@ -23230,21 +26111,19 @@ "text": "Adapters" } ], - "description": [ - "\nDefault inspector adapters created if inspector adapters are not set explicitly." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DefaultInspectorAdapters.requests", "type": "Object", + "tags": [], "label": "requests", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 71 - }, "signature": [ { "pluginId": "inspector", @@ -23253,18 +26132,20 @@ "section": "def-common.RequestAdapter", "text": "RequestAdapter" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 71 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DefaultInspectorAdapters.tables", "type": "Object", + "tags": [], "label": "tables", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 72 - }, "signature": [ { "pluginId": "expressions", @@ -23273,83 +26154,99 @@ "section": "def-common.TablesAdapter", "text": "TablesAdapter" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 72 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 70 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.DerivativeArgs", "type": "Interface", + "tags": [], "label": "DerivativeArgs", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DerivativeArgs.by", "type": "Array", + "tags": [], "label": "by", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 15 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DerivativeArgs.inputColumnId", "type": "string", + "tags": [], "label": "inputColumnId", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DerivativeArgs.outputColumnId", "type": "string", + "tags": [], "label": "outputColumnId", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.DerivativeArgs.outputColumnName", "type": "string", + "tags": [], "label": "outputColumnName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionContext", "type": "Interface", + "tags": [], "label": "ExecutionContext", + "description": [ + "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." + ], "signature": [ { "pluginId": "expressions", @@ -23360,55 +26257,57 @@ }, "" ], - "description": [ - "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionContext.getSearchContext", "type": "Function", + "tags": [], "label": "getSearchContext", "description": [ "\nGet search context of the expression." ], + "signature": [ + "() => ExecutionContextSearch" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 27 }, - "signature": [ - "() => ExecutionContextSearch" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionContext.variables", "type": "Object", + "tags": [], "label": "variables", "description": [ "\nContext variables that can be consumed using `var` and `var_set` functions." ], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 32 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionContext.types", "type": "Object", + "tags": [], "label": "types", "description": [ "\nA map of available expression types." ], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 37 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionContext.abortSignal", "type": "Object", + "tags": [], "label": "abortSignal", "description": [ "\nAdds ability to abort current execution." ], + "signature": [ + "AbortSignal" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 42 }, - "signature": [ - "AbortSignal" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionContext.inspectorAdapters", "type": "Uncategorized", + "tags": [], "label": "inspectorAdapters", "description": [ "\nAdapters for `inspector` plugin." ], + "signature": [ + "InspectorAdapters" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 47 }, - "signature": [ - "InspectorAdapters" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionContext.getSearchSessionId", "type": "Function", + "tags": [], "label": "getSearchSessionId", "description": [ "\nSearch context in which expression should operate." ], + "signature": [ + "() => string | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 52 }, - "signature": [ - "() => string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionContext.getKibanaRequest", "type": "Function", + "tags": [], "label": "getKibanaRequest", "description": [ "\nGetter to retrieve the `KibanaRequest` object inside an expression function.\nUseful for functions which are running on the server and need to perform\noperations that are scoped to a specific user." ], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 59 - }, "signature": [ "(() => ", { @@ -23491,48 +26398,54 @@ "text": "KibanaRequest" }, ") | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 59 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionContext.isSyncColorsEnabled", "type": "Function", + "tags": [], "label": "isSyncColorsEnabled", "description": [ "\nReturns the state (true|false) of the sync colors across panels switch." ], + "signature": [ + "(() => boolean) | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 64 }, - "signature": [ - "(() => boolean) | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/types.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionParams", "type": "Interface", + "tags": [], "label": "ExecutionParams", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionParams.executor", "type": "Object", + "tags": [], "label": "executor", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 58 - }, "signature": [ { "pluginId": "expressions", @@ -23542,18 +26455,20 @@ "text": "Executor" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 72 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionParams.ast", "type": "Object", + "tags": [], "label": "ast", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 59 - }, "signature": [ { "pluginId": "expressions", @@ -23563,32 +26478,36 @@ "text": "ExpressionAstExpression" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 73 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionParams.expression", "type": "string", + "tags": [], "label": "expression", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 60 + "lineNumber": 74 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionParams.params", "type": "Object", + "tags": [], "label": "params", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 61 - }, "signature": [ { "pluginId": "expressions", @@ -23597,19 +26516,23 @@ "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 75 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions", "type": "Interface", + "tags": [], "label": "ExecutionPureTransitions", + "description": [], "signature": [ { "pluginId": "expressions", @@ -23620,19 +26543,19 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions.start", "type": "Function", + "tags": [], "label": "start", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 51 - }, "signature": [ "(state: ", { @@ -23651,18 +26574,20 @@ "text": "ExecutionState" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions.setResult", "type": "Function", + "tags": [], "label": "setResult", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 52 - }, "signature": [ "(state: ", { @@ -23681,18 +26606,20 @@ "text": "ExecutionState" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 52 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions.setError", "type": "Function", + "tags": [], "label": "setError", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 53 - }, "signature": [ "(state: ", { @@ -23711,19 +26638,23 @@ "text": "ExecutionState" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 53 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 50 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionState", "type": "Interface", + "tags": [], "label": "ExecutionState", + "description": [], "signature": [ { "pluginId": "expressions", @@ -23742,19 +26673,19 @@ }, ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionState.ast", "type": "Object", + "tags": [], "label": "ast", "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "expressions", @@ -23763,80 +26694,90 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionState.state", "type": "CompoundType", + "tags": [], "label": "state", "description": [ "\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error." ], + "signature": [ + "\"result\" | \"error\" | \"not-started\" | \"pending\"" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 28 }, - "signature": [ - "\"result\" | \"error\" | \"not-started\" | \"pending\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionState.result", "type": "Uncategorized", + "tags": [], "label": "result", "description": [ "\nResult of the expression execution." ], + "signature": [ + "Output | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 33 }, - "signature": [ - "Output | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutionState.error", "type": "Object", + "tags": [], "label": "error", "description": [ "\nError happened during the execution." ], + "signature": [ + "Error | undefined" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 38 }, - "signature": [ - "Error | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors", "type": "Interface", + "tags": [], "label": "ExecutorPureSelectors", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors.getFunction", "type": "Function", + "tags": [], "label": "getFunction", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 44 - }, "signature": [ "(state: ", { @@ -23855,18 +26796,20 @@ "text": "ExpressionFunction" }, " | null" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 44 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors.getType", "type": "Function", + "tags": [], "label": "getType", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 45 - }, "signature": [ "(state: ", { @@ -23885,18 +26828,20 @@ "text": "ExpressionType" }, " | null" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 45 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors.getContext", "type": "Function", + "tags": [], "label": "getContext", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 46 - }, "signature": [ "(state: ", { @@ -23907,32 +26852,36 @@ "text": "ExecutorState" }, ">) => () => Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 46 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 43 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutorPureTransitions", "type": "Interface", + "tags": [], "label": "ExecutorPureTransitions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutorPureTransitions.addFunction", "type": "Function", + "tags": [], "label": "addFunction", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 29 - }, "signature": [ "(state: ", { @@ -23959,18 +26908,20 @@ "text": "ExecutorState" }, ">" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutorPureTransitions.addType", "type": "Function", + "tags": [], "label": "addType", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 30 - }, "signature": [ "(state: ", { @@ -23997,18 +26948,20 @@ "text": "ExecutorState" }, ">" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 30 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutorPureTransitions.extendContext", "type": "Function", + "tags": [], "label": "extendContext", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 31 - }, "signature": [ "(state: ", { @@ -24027,19 +26980,23 @@ "text": "ExecutorState" }, ">" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 31 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutorState", "type": "Interface", + "tags": [], "label": "ExecutorState", + "description": [], "signature": [ { "pluginId": "expressions", @@ -24050,19 +27007,19 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutorState.functions", "type": "Object", + "tags": [], "label": "functions", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 17 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutorState.types", "type": "Object", + "tags": [], "label": "types", "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 18 - }, "signature": [ "Record" - ] + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExecutorState.context", "type": "Uncategorized", + "tags": [], "label": "context", "description": [], + "signature": [ + "Context" + ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 19 }, - "signature": [ - "Context" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpressionBuilder", "type": "Interface", + "tags": [], "label": "ExpressionAstExpressionBuilder", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpressionBuilder.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nUsed to identify expression builder objects." ], + "signature": [ + "\"expression_builder\"" + ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 48 }, - "signature": [ - "\"expression_builder\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpressionBuilder.functions", "type": "Array", + "tags": [], "label": "functions", "description": [ "\nArray of each of the `buildExpressionFunction()` instances\nin this expression. Use this to remove or reorder functions\nin the expression." ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 54 - }, "signature": [ { "pluginId": "expressions", @@ -24170,22 +27137,24 @@ "text": "AnyExpressionFunctionDefinition" }, ">[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 54 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionAstExpressionBuilder.findFunction", + "type": "Function", "tags": [ "return" ], - "id": "def-common.ExpressionAstExpressionBuilder.findFunction", - "type": "Function", "label": "findFunction", "description": [ "\nRecursively searches expression for all ocurrences of the\nfunction, including in subexpressions.\n\nUseful when performing migrations on a specific function,\nas you can iterate over the array of references and update\nall functions at once.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 66 - }, "signature": [ "[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 66 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionAstExpressionBuilder.toAst", + "type": "Function", "tags": [ "return" ], - "id": "def-common.ExpressionAstExpressionBuilder.toAst", - "type": "Function", "label": "toAst", "description": [ "\nConverts expression to an AST.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 74 - }, "signature": [ "() => ", { @@ -24245,37 +27216,43 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 74 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionAstExpressionBuilder.toString", + "type": "Function", "tags": [ "return" ], - "id": "def-common.ExpressionAstExpressionBuilder.toString", - "type": "Function", "label": "toString", "description": [ "\nConverts expression to an expression string.\n" ], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 80 }, - "signature": [ - "() => string" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/ast/build_expression.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder", "type": "Interface", + "tags": [], "label": "ExpressionAstFunctionBuilder", + "description": [], "signature": [ { "pluginId": "expressions", @@ -24286,37 +27263,39 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nUsed to identify expression function builder objects." ], + "signature": [ + "\"expression_function_builder\"" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 63 }, - "signature": [ - "\"expression_function_builder\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.name", "type": "Uncategorized", + "tags": [], "label": "name", "description": [ "\nName of this expression function." ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 67 - }, "signature": [ { "pluginId": "expressions", @@ -24326,38 +27305,42 @@ "text": "InferFunctionDefinition" }, "[\"name\"]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 67 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.arguments", "type": "Object", + "tags": [], "label": "arguments", "description": [ "\nObject of all args currently added to the function. This is\nstructured similarly to `ExpressionAstFunction['arguments']`,\nhowever any subexpressions are returned as expression builder\ninstances instead of expression ASTs." ], + "signature": [ + "FunctionBuilderArguments" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 74 }, - "signature": [ - "FunctionBuilderArguments" - ] + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionAstFunctionBuilder.addArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-common.ExpressionAstFunctionBuilder.addArgument", - "type": "Function", "label": "addArgument", "description": [ "\nAdds an additional argument to the function. For multi-args,\nthis should be called once for each new arg. Note that TS\nwill not enforce whether multi-args are available, so only\nuse this to update an existing arg if you are certain it\nis a multi-arg.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 86 - }, "signature": [ ">(name: A, value: ", { @@ -24368,22 +27351,24 @@ "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A]) => this" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 86 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionAstFunctionBuilder.getArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-common.ExpressionAstFunctionBuilder.getArgument", - "type": "Function", "label": "getArgument", "description": [ "\nRetrieves an existing argument by name.\nUseful when you want to retrieve the current array of args and add\nsomething to it before calling `replaceArgument`. Any subexpression\narguments will be returned as expression builder instances.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 99 - }, "signature": [ ">(name: A) => (", { @@ -24394,22 +27379,24 @@ "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[] | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 99 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionAstFunctionBuilder.replaceArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-common.ExpressionAstFunctionBuilder.replaceArgument", - "type": "Function", "label": "replaceArgument", "description": [ "\nOverwrites an existing argument with a new value.\nIn order to support multi-args, the value given must always be\nan array.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 111 - }, "signature": [ ">(name: A, value: (", { @@ -24420,40 +27407,44 @@ "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[]) => this" - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 111 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionAstFunctionBuilder.removeArgument", + "type": "Function", "tags": [ "return" ], - "id": "def-common.ExpressionAstFunctionBuilder.removeArgument", - "type": "Function", "label": "removeArgument", "description": [ "\nRemoves an (optional) argument from the function.\n\nTypeScript will enforce that you only remove optional\narguments. For manipulating required args, use `replaceArgument`.\n" ], + "signature": [ + ">>(name: A) => this" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 124 }, - "signature": [ - ">>(name: A) => this" - ] + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionAstFunctionBuilder.toAst", + "type": "Function", "tags": [ "return" ], - "id": "def-common.ExpressionAstFunctionBuilder.toAst", - "type": "Function", "label": "toAst", "description": [ "\nConverts function to an AST.\n" ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 130 - }, "signature": [ "() => ", { @@ -24463,80 +27454,90 @@ "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 130 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionAstFunctionBuilder.toString", + "type": "Function", "tags": [ "return" ], - "id": "def-common.ExpressionAstFunctionBuilder.toString", - "type": "Function", "label": "toString", "description": [ "\nConverts function to an expression string.\n" ], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 136 }, - "signature": [ - "() => string" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/ast/build_function.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionExecOptions", "type": "Interface", + "tags": [], "label": "ExpressionExecOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionExecOptions.debug", "type": "CompoundType", + "tags": [], "label": "debug", "description": [ "\nWhether to execute expression in *debug mode*. In *debug mode* inputs and\noutputs as well as all resolved arguments and time it took to execute each\nfunction are saved and are available for introspection." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 33 + "lineNumber": 34 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams", "type": "Interface", + "tags": [], "label": "ExpressionExecutionParams", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.searchContext", "type": "Object", + "tags": [], "label": "searchContext", "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 42 - }, "signature": [ { "pluginId": "kibanaUtils", @@ -24546,50 +27547,56 @@ "text": "SerializableState" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 43 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.variables", "type": "Object", + "tags": [], "label": "variables", "description": [], + "signature": [ + "Record | undefined" + ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 44 + "lineNumber": 45 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.debug", "type": "CompoundType", + "tags": [], "label": "debug", "description": [ "\nWhether to execute expression in *debug mode*. In *debug mode* inputs and\noutputs as well as all resolved arguments and time it took to execute each\nfunction are saved and are available for introspection." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 51 + "lineNumber": 52 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.kibanaRequest", "type": "Object", + "tags": [], "label": "kibanaRequest", "description": [ "\nMakes a `KibanaRequest` object available to expression functions. Useful for\nfunctions which are running on the server and need to perform operations that\nare scoped to a specific user." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 58 - }, "signature": [ { "pluginId": "core", @@ -24599,46 +27606,52 @@ "text": "KibanaRequest" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 59 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.searchSessionId", "type": "string", + "tags": [], "label": "searchSessionId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 60 + "lineNumber": 61 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.syncColors", "type": "CompoundType", + "tags": [], "label": "syncColors", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 62 + "lineNumber": 63 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.inspectorAdapters", "type": "Object", + "tags": [], "label": "inspectorAdapters", "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 64 - }, "signature": [ { "pluginId": "inspector", @@ -24648,19 +27661,25 @@ "text": "Adapters" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 65 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 41 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition", "type": "Interface", + "tags": [], "label": "ExpressionFunctionDefinition", + "description": [ + "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." + ], "signature": [ { "pluginId": "expressions", @@ -24687,55 +27706,57 @@ }, "[]>>>" ], - "description": [ - "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.name", "type": "Uncategorized", + "tags": [], "label": "name", "description": [ "\nThe name of the function, as will be used in expression." ], + "signature": [ + "Name" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 40 }, - "signature": [ - "Name" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.disabled", "type": "CompoundType", + "tags": [], "label": "disabled", "description": [ "\nif set to true function will be disabled (but its migrate function will still be available)" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 45 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [ "\nName of type of value this function outputs." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 50 - }, "signature": [ "\"date\" | \"filter\" | ", { @@ -24748,20 +27769,22 @@ "<", "UnwrapPromiseOrReturn", "> | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 50 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [ "\nList of allowed type names for input value of this function. If this\nproperty is set the input of function will be cast to the first possible\ntype in this list. If this property is missing the input will be provided\nto the function as-is." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 58 - }, "signature": [ { "pluginId": "expressions", @@ -24771,20 +27794,22 @@ "text": "TypeToString" }, "[] | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 58 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.args", "type": "Object", + "tags": [], "label": "args", "description": [ "\nSpecification of arguments that function supports. This list will also be\nused for autocomplete functionality when your function is being edited." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 64 - }, "signature": [ "{ [key in keyof Arguments]: ", { @@ -24795,28 +27820,36 @@ "text": "ArgumentType" }, "; }" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 64 + }, + "deprecated": false }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionFunctionDefinition.aliases", + "type": "Array", "tags": [ "todo" ], - "id": "def-common.ExpressionFunctionDefinition.aliases", - "type": "Array", "label": "aliases", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 69 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nHelp text displayed in the Expression editor. This text should be\ninternationalized." @@ -24824,119 +27857,202 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 75 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.fn", "type": "Function", + "tags": [], "label": "fn", - "signature": [ - "(input: Input, args: Arguments, context: Context) => Output" - ], "description": [ "\nThe actual implementation of the function.\n" ], + "signature": [ + "(input: Input, args: Arguments, context: Context) => Output" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, - "signature": [ - "Input" - ], "description": [ "Output of the previous function, or initial input." ], + "signature": [ + "Input" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.fn.$2", "type": "Uncategorized", + "tags": [], "label": "args", - "isRequired": true, - "signature": [ - "Arguments" - ], "description": [ "Parameters set for this function in expression." ], + "signature": [ + "Arguments" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.fn.$3", "type": "Uncategorized", + "tags": [], "label": "context", - "isRequired": true, - "signature": [ - "Context" - ], "description": [ "Object with functions to perform side effects. This object\nis created for the duration of the execution of expression and is the\nsame for all functions in expression chain." ], + "signature": [ + "Context" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 86 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 86 - } + "returnComment": [] }, { + "parentPluginId": "expressions", + "id": "def-common.ExpressionFunctionDefinition.context", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-common.ExpressionFunctionDefinition.context", - "type": "Object", "label": "context", "description": [], + "signature": [ + "{ types: any[] | undefined; } | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", "lineNumber": 91 }, - "signature": [ - "{ types: any[] | undefined; } | undefined" + "deprecated": true, + "references": [ + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/public/functions/filters.ts", + "lineNumber": 60 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts", + "lineNumber": 36 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts", + "lineNumber": 41 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts", + "lineNumber": 35 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts", + "lineNumber": 24 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts", + "lineNumber": 47 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts", + "lineNumber": 32 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/escount.ts", + "lineNumber": 33 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/esdocs.ts", + "lineNumber": 36 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/essql.ts", + "lineNumber": 32 + } + } ] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions", "type": "Interface", + "tags": [], "label": "ExpressionFunctionDefinitions", "description": [ "\nA mapping of `ExpressionFunctionDefinition`s for functions which the\nExpressions services provides out-of-the-box. Any new functions registered\nby the Expressions plugin should have their types added here.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 116 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.clog", "type": "Object", + "tags": [], "label": "clog", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 117 - }, "signature": [ { "pluginId": "expressions", @@ -24945,18 +28061,20 @@ "section": "def-common.ExpressionFunctionClog", "text": "ExpressionFunctionClog" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 117 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.font", "type": "Object", + "tags": [], "label": "font", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 118 - }, "signature": [ { "pluginId": "expressions", @@ -24965,18 +28083,20 @@ "section": "def-common.ExpressionFunctionFont", "text": "ExpressionFunctionFont" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 118 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.var_set", "type": "Object", + "tags": [], "label": "var_set", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 119 - }, "signature": [ { "pluginId": "expressions", @@ -24985,18 +28105,20 @@ "section": "def-common.ExpressionFunctionVarSet", "text": "ExpressionFunctionVarSet" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 119 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.var", "type": "Object", + "tags": [], "label": "var", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 120 - }, "signature": [ { "pluginId": "expressions", @@ -25005,18 +28127,20 @@ "section": "def-common.ExpressionFunctionVar", "text": "ExpressionFunctionVar" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 120 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.theme", "type": "Object", + "tags": [], "label": "theme", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 121 - }, "signature": [ { "pluginId": "expressions", @@ -25025,18 +28149,20 @@ "section": "def-common.ExpressionFunctionTheme", "text": "ExpressionFunctionTheme" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 121 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.cumulative_sum", "type": "Object", + "tags": [], "label": "cumulative_sum", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 122 - }, "signature": [ { "pluginId": "expressions", @@ -25045,18 +28171,20 @@ "section": "def-common.ExpressionFunctionCumulativeSum", "text": "ExpressionFunctionCumulativeSum" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 122 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.derivative", "type": "Object", + "tags": [], "label": "derivative", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 123 - }, "signature": [ { "pluginId": "expressions", @@ -25065,18 +28193,20 @@ "section": "def-common.ExpressionFunctionDerivative", "text": "ExpressionFunctionDerivative" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 123 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.moving_average", "type": "Object", + "tags": [], "label": "moving_average", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 124 - }, "signature": [ { "pluginId": "expressions", @@ -25085,69 +28215,81 @@ "section": "def-common.ExpressionFunctionMovingAverage", "text": "ExpressionFunctionMovingAverage" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 124 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 116 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionImage", "type": "Interface", + "tags": [], "label": "ExpressionImage", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionImage.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"image\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 15 }, - "signature": [ - "\"image\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionImage.mode", "type": "string", + "tags": [], "label": "mode", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionImage.dataurl", "type": "string", + "tags": [], "label": "dataurl", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 17 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/image.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition", "type": "Interface", + "tags": [], "label": "ExpressionRenderDefinition", + "description": [], "signature": [ { "pluginId": "expressions", @@ -25158,13 +28300,17 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nTechnical name of the renderer, used as ID to identify renderer in\nexpression renderer registry. This must match the name of the expression\nfunction that is used to create the `type: render` object." @@ -25172,60 +28318,68 @@ "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.displayName", "type": "string", + "tags": [], "label": "displayName", "description": [ "\nA user friendly name of the renderer as will be displayed to user in UI." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.help", "type": "string", + "tags": [], "label": "help", "description": [ "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 26 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.validate", "type": "Function", + "tags": [], "label": "validate", "description": [ "\nUsed to validate the data before calling the render function." ], + "signature": [ + "(() => Error | undefined) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 31 }, - "signature": [ - "(() => Error | undefined) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.reuseDomNode", "type": "boolean", + "tags": [], "label": "reuseDomNode", "description": [ "\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default." @@ -25233,20 +28387,18 @@ "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 37 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.render", "type": "Function", + "tags": [], "label": "render", "description": [ "\nThe function called to render the output data of an expression." ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 42 - }, "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { @@ -25257,32 +28409,36 @@ "text": "IInterpreterRenderHandlers" }, ") => void | Promise" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 42 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionServiceParams", "type": "Interface", + "tags": [], "label": "ExpressionServiceParams", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 151 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionServiceParams.executor", "type": "Object", + "tags": [], "label": "executor", "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 151 - }, "signature": [ { "pluginId": "expressions", @@ -25292,18 +28448,20 @@ "text": "Executor" }, "> | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 152 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionServiceParams.renderers", "type": "Object", + "tags": [], "label": "renderers", "description": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 152 - }, "signature": [ { "pluginId": "expressions", @@ -25313,36 +28471,40 @@ "text": "ExpressionRendererRegistry" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 153 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 150 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart", "type": "Interface", + "tags": [], "label": "ExpressionsServiceStart", "description": [ "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *start* life-cycle." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 72 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getFunction", "type": "Function", + "tags": [], "label": "getFunction", "description": [ "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 78 - }, "signature": [ "(name: string) => ", { @@ -25353,20 +28515,22 @@ "text": "ExpressionFunction" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 79 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getRenderer", "type": "Function", + "tags": [], "label": "getRenderer", "description": [ "\nGet a registered `ExpressionRenderer` by its name, which was registered\nusing the `registerRenderer` method. The returned `ExpressionRenderer`\ninstance is an internal representation of the renderer in Expressions\nservice - do not mutate that object." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 86 - }, "signature": [ "(name: string) => ", { @@ -25377,20 +28541,22 @@ "text": "ExpressionRenderer" }, " | null" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 87 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getType", "type": "Function", + "tags": [], "label": "getType", "description": [ "\nGet a registered `ExpressionType` by its name, which was registered\nusing the `registerType` method. The returned `ExpressionType`\ninstance is an internal representation of the type in Expressions\nservice - do not mutate that object." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 94 - }, "signature": [ "(name: string) => ", { @@ -25401,20 +28567,22 @@ "text": "ExpressionType" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 95 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.run", "type": "Function", + "tags": [], "label": "run", "description": [ "\nExecutes expression string or a parsed expression AST and immediately\nreturns the result.\n\nBelow example will execute `sleep 100 | clog` expression with `123` initial\ninput to the first function.\n\n```ts\nexpressions.run('sleep 100 | clog', 123);\n```\n\n- `sleep 100` will delay execution by 100 milliseconds and pass the `123` input as\n its output.\n- `clog` will print to console `123` and pass it as its output.\n- The final result of the execution will be `123`.\n\nOptionally, you can pass an object as the third argument which will be used\nto extend the `ExecutionContext`—an object passed to each function\nas the third argument, that allows functions to perform side-effects.\n\n```ts\nexpressions.run('...', null, { elasticsearchClient });\n```" ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 120 - }, "signature": [ "(ast: string | ", { @@ -25433,20 +28601,22 @@ "text": "ExpressionExecutionParams" }, " | undefined) => Promise" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 121 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.execute", "type": "Function", + "tags": [], "label": "execute", "description": [ "\nStarts expression execution and immediately returns `ExecutionContract`\ninstance that tracks the progress of the execution and can be used to\ninteract with the execution." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 131 - }, "signature": [ "(ast: string | ", { @@ -25473,20 +28643,22 @@ "text": "ExecutionContract" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 132 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.fork", "type": "Function", + "tags": [], "label": "fork", "description": [ "\nCreate a new instance of `ExpressionsService`. The new instance inherits\nall state of the original `ExpressionsService`, including all expression\ntypes, expression functions and context. Also, all new types and functions\nregistered in the original services AFTER the forking event will be\navailable in the forked instance. However, all new types and functions\nregistered in the forked instances will NOT be available to the original\nservice." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 147 - }, "signature": [ "() => ", { @@ -25496,19 +28668,25 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 148 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 71 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition", "type": "Interface", + "tags": [], "label": "ExpressionTypeDefinition", + "description": [ + "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." + ], "signature": [ { "pluginId": "expressions", @@ -25519,77 +28697,83 @@ }, "" ], - "description": [ - "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.name", "type": "Uncategorized", + "tags": [], "label": "name", "description": [], + "signature": [ + "Name" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 31 }, - "signature": [ - "Name" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.validate", "type": "Function", + "tags": [], "label": "validate", "description": [], + "signature": [ + "((type: any) => void | Error) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 32 }, - "signature": [ - "((type: any) => void | Error) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.serialize", "type": "Function", + "tags": [], "label": "serialize", "description": [], + "signature": [ + "((type: Value) => SerializedType) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 33 }, - "signature": [ - "((type: Value) => SerializedType) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.deserialize", "type": "Function", + "tags": [], "label": "deserialize", "description": [], + "signature": [ + "((type: SerializedType) => Value) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 34 }, - "signature": [ - "((type: SerializedType) => Value) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.from", "type": "Object", + "tags": [], "label": "from", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/types.ts", - "lineNumber": 37 - }, "signature": [ "{ [type: string]: ", { @@ -25600,18 +28784,20 @@ "text": "ExpressionValueConverter" }, "; } | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.to", "type": "Object", + "tags": [], "label": "to", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/types.ts", - "lineNumber": 40 - }, "signature": [ "{ [type: string]: ", { @@ -25622,62 +28808,70 @@ "text": "ExpressionValueConverter" }, "; } | undefined" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 40 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.help", "type": "string", + "tags": [], "label": "help", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 43 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/types.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeStyle", "type": "Interface", + "tags": [], "label": "ExpressionTypeStyle", "description": [ "\nAn object that represents style information, typically CSS." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 120 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeStyle.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"style\"" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 121 }, - "signature": [ - "\"style\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeStyle.spec", "type": "Object", + "tags": [], "label": "spec", "description": [], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 122 - }, "signature": [ { "pluginId": "expressions", @@ -25686,173 +28880,197 @@ "section": "def-common.CSSStyle", "text": "CSSStyle" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 122 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.ExpressionTypeStyle.css", "type": "string", + "tags": [], "label": "css", "description": [], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 123 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/style.ts", - "lineNumber": 120 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.Font", "type": "Interface", + "tags": [], "label": "Font", "description": [ "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Font.label", "type": "CompoundType", + "tags": [], "label": "label", "description": [], + "signature": [ + "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 26 }, - "signature": [ - "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Font.value", "type": "CompoundType", + "tags": [], "label": "value", "description": [], + "signature": [ + "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 27 }, - "signature": [ - "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers", "type": "Interface", + "tags": [], "label": "IInterpreterRenderHandlers", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.done", "type": "Function", + "tags": [], "label": "done", "description": [ "\nDone increments the number of rendering successes" ], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 67 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.onDestroy", "type": "Function", + "tags": [], "label": "onDestroy", "description": [], + "signature": [ + "(fn: () => void) => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 68 }, - "signature": [ - "(fn: () => void) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.reload", "type": "Function", + "tags": [], "label": "reload", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 69 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.update", "type": "Function", + "tags": [], "label": "update", "description": [], + "signature": [ + "(params: any) => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 70 }, - "signature": [ - "(params: any) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.event", "type": "Function", + "tags": [], "label": "event", "description": [], + "signature": [ + "(event: any) => void" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 71 }, - "signature": [ - "(event: any) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.hasCompatibleActions", "type": "Function", + "tags": [], "label": "hasCompatibleActions", "description": [], + "signature": [ + "((event: any) => Promise) | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 72 }, - "signature": [ - "((event: any) => Promise) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.getRenderMode", "type": "Function", + "tags": [], "label": "getRenderMode", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 73 - }, "signature": [ "() => ", { @@ -25862,49 +29080,57 @@ "section": "def-common.RenderMode", "text": "RenderMode" } - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 73 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.isSyncColorsEnabled", "type": "Function", + "tags": [], "label": "isSyncColorsEnabled", "description": [], + "signature": [ + "() => boolean" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 74 }, - "signature": [ - "() => boolean" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.uiState", "type": "Unknown", + "tags": [], "label": "uiState", "description": [ "\nThis uiState interface is actually `PersistedState` from the visualizations plugin,\nbut expressions cannot know about vis or it creates a mess of circular dependencies.\nDownstream consumers of the uiState handler will need to cast for now." ], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 80 }, - "signature": [ - "unknown" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "lineNumber": 63 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.IRegistry", "type": "Interface", + "tags": [], "label": "IRegistry", + "description": [], "signature": [ { "pluginId": "expressions", @@ -25915,121 +29141,136 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.IRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => T | null" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.IRegistry.get.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/expressions/common/types/registry.ts", "lineNumber": 10 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/types/registry.ts", - "lineNumber": 10 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.IRegistry.toJS", "type": "Function", + "tags": [], "label": "toJS", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/types/registry.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.IRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => T[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/types/registry.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/types/registry.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.MapColumnArguments", "type": "Interface", + "tags": [], "label": "MapColumnArguments", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.MapColumnArguments.id", "type": "CompoundType", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | null | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 14 + "lineNumber": 16 }, - "signature": [ - "string | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.MapColumnArguments.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 15 - } + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.MapColumnArguments.expression", "type": "Function", + "tags": [], "label": "expression", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 16 - }, "signature": [ "((datatable: ", { @@ -26039,228 +29280,292 @@ "section": "def-common.Datatable", "text": "Datatable" }, - ") => Promise) | undefined" - ] + ") => ", + "Observable", + ") | undefined" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 18 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.MapColumnArguments.expression.$1", + "type": "Object", + "tags": [], + "label": "datatable", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 18 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.MapColumnArguments.copyMetaFrom", "type": "CompoundType", + "tags": [], "label": "copyMetaFrom", "description": [], + "signature": [ + "string | null | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 17 + "lineNumber": 19 }, - "signature": [ - "string | null | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs", "type": "Interface", + "tags": [], "label": "MovingAverageArgs", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs.by", "type": "Array", + "tags": [], "label": "by", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 15 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs.inputColumnId", "type": "string", + "tags": [], "label": "inputColumnId", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs.outputColumnId", "type": "string", + "tags": [], "label": "outputColumnId", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs.outputColumnName", "type": "string", + "tags": [], "label": "outputColumnName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs.window", "type": "number", + "tags": [], "label": "window", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 19 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.PointSeriesColumn", "type": "Interface", + "tags": [], "label": "PointSeriesColumn", "description": [ "\nColumn in a PointSeries" ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.PointSeriesColumn.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"string\" | \"number\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 24 }, - "signature": [ - "\"string\" | \"number\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.PointSeriesColumn.role", "type": "CompoundType", + "tags": [], "label": "role", "description": [], + "signature": [ + "\"measure\" | \"dimension\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 25 }, - "signature": [ - "\"measure\" | \"dimension\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.PointSeriesColumn.expression", "type": "string", + "tags": [], "label": "expression", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 26 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.Range", "type": "Interface", + "tags": [], "label": "Range", "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Range.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"range\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 15 }, - "signature": [ - "\"range\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Range.from", "type": "number", + "tags": [], "label": "from", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Range.to", "type": "number", + "tags": [], "label": "to", "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Range.label", "type": "string", + "tags": [], "label": "label", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/range.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.SerializedDatatable", "type": "Interface", + "tags": [], "label": "SerializedDatatable", + "description": [], "signature": [ { "pluginId": "expressions", @@ -26278,34 +29583,40 @@ "text": "Datatable" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 104 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.SerializedDatatable.rows", "type": "Array", + "tags": [], "label": "rows", "description": [], + "signature": [ + "string[][]" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 105 }, - "signature": [ - "string[][]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 104 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.SerializedFieldFormat", "type": "Interface", + "tags": [], "label": "SerializedFieldFormat", + "description": [ + "\nJSON representation of a field formatter configuration.\nIs used to carry information about how to format data in\na data table as part of the column definition." + ], "signature": [ { "pluginId": "expressions", @@ -26316,53 +29627,55 @@ }, "" ], - "description": [ - "\nJSON representation of a field formatter configuration.\nIs used to carry information about how to format data in\na data table as part of the column definition." - ], - "tags": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.SerializedFieldFormat.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 54 + "lineNumber": 56 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.SerializedFieldFormat.params", "type": "Uncategorized", + "tags": [], "label": "params", "description": [], + "signature": [ + "TParams | undefined" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 55 + "lineNumber": 57 }, - "signature": [ - "TParams | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 53 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "expressions", "id": "def-common.BackgroundRepeat", "type": "Enum", - "label": "BackgroundRepeat", "tags": [], + "label": "BackgroundRepeat", "description": [ "\nEnum of supported CSS `background-repeat` properties." ], @@ -26370,13 +29683,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 14 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.BackgroundSize", "type": "Enum", - "label": "BackgroundSize", "tags": [], + "label": "BackgroundSize", "description": [ "\nEnum of supported CSS `background-size` properties." ], @@ -26384,13 +29699,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 26 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.FontStyle", "type": "Enum", - "label": "FontStyle", "tags": [], + "label": "FontStyle", "description": [ "\nEnum of supported CSS `font-style` properties." ], @@ -26398,13 +29715,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 35 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.FontWeight", "type": "Enum", - "label": "FontWeight", "tags": [], + "label": "FontWeight", "description": [ "\nEnum of supported CSS `font-weight` properties." ], @@ -26412,13 +29731,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 43 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.Overflow", "type": "Enum", - "label": "Overflow", "tags": [], + "label": "Overflow", "description": [ "\nEnum of supported CSS `overflow` properties." ], @@ -26426,13 +29747,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 62 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.TextAlignment", "type": "Enum", - "label": "TextAlignment", "tags": [], + "label": "TextAlignment", "description": [ "\nEnum of supported CSS `text-align` properties." ], @@ -26440,13 +29763,15 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 72 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.TextDecoration", "type": "Enum", - "label": "TextDecoration", "tags": [], + "label": "TextDecoration", "description": [ "\nEnum of supported CSS `text-decoration` properties." ], @@ -26454,22 +29779,20 @@ "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 82 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "expressions", "id": "def-common.AnyExpressionFunctionDefinition", "type": "Type", - "label": "AnyExpressionFunctionDefinition", "tags": [], + "label": "AnyExpressionFunctionDefinition", "description": [ "\nType to capture every possible expression function definition." ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/types.ts", - "lineNumber": 102 - }, "signature": [ "ExpressionFunctionDefinition, any, ExecutionContext<", { @@ -26483,144 +29806,162 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 102 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.AnyExpressionRenderDefinition", "type": "Type", - "label": "AnyExpressionRenderDefinition", "tags": [], + "label": "AnyExpressionRenderDefinition", "description": [], + "signature": [ + "ExpressionRenderDefinition" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 49 }, - "signature": [ - "ExpressionRenderDefinition" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.AnyExpressionTypeDefinition", "type": "Type", - "label": "AnyExpressionTypeDefinition", "tags": [], + "label": "AnyExpressionTypeDefinition", "description": [], + "signature": [ + "ExpressionTypeDefinition" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 46 }, - "signature": [ - "ExpressionTypeDefinition" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ArgumentType", "type": "Type", - "label": "ArgumentType", "tags": [], + "label": "ArgumentType", "description": [ "\nThis type represents all of the possible combinations of properties of an\nArgument in an Expression Function. The presence or absence of certain fields\ninfluence the shape and presence of others within each `arg` in the specification." ], + "signature": [ + "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/arguments.ts", "lineNumber": 16 }, - "signature": [ - "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.DatatableColumnType", "type": "Type", - "label": "DatatableColumnType", "tags": [], + "label": "DatatableColumnType", "description": [ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 36 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.DatatableRow", "type": "Type", - "label": "DatatableRow", "tags": [], + "label": "DatatableRow", "description": [ "\nThis type represents a row in a `Datatable`." ], + "signature": [ + "{ [x: string]: any; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 57 }, - "signature": [ - "{ [x: string]: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ErrorLike", "type": "Type", - "label": "ErrorLike", "tags": [], + "label": "ErrorLike", "description": [], + "signature": [ + "SerializedError & { original?: SerializedError | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/util/create_error.ts", "lineNumber": 17 }, - "signature": [ - "SerializedError & { original?: SerializedError | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionContainer", "type": "Type", - "label": "ExecutionContainer", "tags": [], + "label": "ExecutionContainer", "description": [], + "signature": [ + "StateContainer, ExecutionPureTransitions, {}>" + ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 73 }, - "signature": [ - "StateContainer, ExecutionPureTransitions, {}>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutorContainer", "type": "Type", - "label": "ExecutorContainer", "tags": [], + "label": "ExecutorContainer", "description": [], + "signature": [ + "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" + ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 55 }, - "signature": [ - "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionAstArgument", "type": "Type", - "label": "ExpressionAstArgument", "tags": [], + "label": "ExpressionAstArgument", "description": [], - "source": { - "path": "src/plugins/expressions/common/ast/types.ts", - "lineNumber": 77 - }, "signature": [ "string | number | false | true | ", { @@ -26631,48 +29972,54 @@ "text": "ExpressionAstExpression" } ], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 77 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpression", "type": "Type", - "label": "ExpressionAstExpression", "tags": [], + "label": "ExpressionAstExpression", "description": [], + "signature": [ + "{ type: 'expression'; chain: ExpressionAstFunction[]; }" + ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", "lineNumber": 16 }, - "signature": [ - "{ type: 'expression'; chain: ExpressionAstFunction[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunction", "type": "Type", - "label": "ExpressionAstFunction", "tags": [], + "label": "ExpressionAstFunction", "description": [], + "signature": [ + "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", "lineNumber": 21 }, - "signature": [ - "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionDebug", "type": "Type", - "label": "ExpressionAstFunctionDebug", "tags": [], + "label": "ExpressionAstFunctionDebug", "description": [], - "source": { - "path": "src/plugins/expressions/common/ast/types.ts", - "lineNumber": 32 - }, "signature": [ "{ success: boolean; fn: string; input: ExpressionValue; args: Record; output?: ExpressionValue; error?: ", { @@ -26700,18 +30047,20 @@ }, " | undefined; }> | undefined; rawError?: any | Error; duration: number | undefined; }" ], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 32 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionAstNode", "type": "Type", - "label": "ExpressionAstNode", "tags": [], + "label": "ExpressionAstNode", "description": [], - "source": { - "path": "src/plugins/expressions/common/ast/types.ts", - "lineNumber": 11 - }, "signature": [ "string | number | false | true | ", { @@ -26730,18 +30079,20 @@ "text": "ExpressionAstExpression" } ], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionClog", "type": "Type", - "label": "ExpressionFunctionClog", "tags": [], + "label": "ExpressionFunctionClog", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", - "lineNumber": 11 - }, "signature": [ "ExpressionFunctionDefinition<\"clog\", unknown, {}, unknown, ", { @@ -26763,18 +30114,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionCumulativeSum", "type": "Type", - "label": "ExpressionFunctionCumulativeSum", "tags": [], + "label": "ExpressionFunctionCumulativeSum", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", - "lineNumber": 21 - }, "signature": [ "ExpressionFunctionDefinition<\"cumulative_sum\", Datatable, CumulativeSumArgs, Datatable, ", { @@ -26796,18 +30149,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDerivative", "type": "Type", - "label": "ExpressionFunctionDerivative", "tags": [], + "label": "ExpressionFunctionDerivative", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", - "lineNumber": 21 - }, "signature": [ "ExpressionFunctionDefinition<\"derivative\", Datatable, DerivativeArgs, Datatable, ", { @@ -26829,18 +30184,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionFont", "type": "Type", - "label": "ExpressionFunctionFont", "tags": [], + "label": "ExpressionFunctionFont", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 44 - }, "signature": [ "ExpressionFunctionDefinition<\"font\", null, Arguments, ", { @@ -26870,18 +30227,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 44 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionMovingAverage", "type": "Type", - "label": "ExpressionFunctionMovingAverage", "tags": [], + "label": "ExpressionFunctionMovingAverage", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", - "lineNumber": 22 - }, "signature": [ "ExpressionFunctionDefinition<\"moving_average\", Datatable, MovingAverageArgs, Datatable, ", { @@ -26903,18 +30262,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 22 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionTheme", "type": "Type", - "label": "ExpressionFunctionTheme", "tags": [], + "label": "ExpressionFunctionTheme", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", - "lineNumber": 20 - }, "signature": [ "ExpressionFunctionDefinition<\"theme\", null, Arguments, any, ", { @@ -26936,18 +30297,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionVar", "type": "Type", - "label": "ExpressionFunctionVar", "tags": [], + "label": "ExpressionFunctionVar", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", - "lineNumber": 16 - }, "signature": [ "ExpressionFunctionDefinition<\"var\", unknown, Arguments, unknown, ", { @@ -26969,18 +30332,20 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 16 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionVarSet", "type": "Type", - "label": "ExpressionFunctionVarSet", "tags": [], + "label": "ExpressionFunctionVarSet", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", - "lineNumber": 17 - }, "signature": [ "ExpressionFunctionDefinition<\"var_set\", unknown, Arguments, unknown, ", { @@ -27002,20 +30367,22 @@ "SerializableState", ">>" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 17 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup", "type": "Type", - "label": "ExpressionsServiceSetup", "tags": [], + "label": "ExpressionsServiceSetup", "description": [ "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *setup* life-cycle." ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 26 - }, "signature": [ "{ readonly getType: (name: string) => ", { @@ -27058,193 +30425,217 @@ "text": "ExpressionRenderer" } ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 27 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionValue", "type": "Type", - "label": "ExpressionValue", "tags": [], + "label": "ExpressionValue", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 15 }, - "signature": [ - "any" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionValueBoxed", "type": "Type", - "label": "ExpressionValueBoxed", "tags": [], + "label": "ExpressionValueBoxed", "description": [], + "signature": [ + "{ type: Type; } & Value" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 11 }, - "signature": [ - "{ type: Type; } & Value" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionValueConverter", "type": "Type", - "label": "ExpressionValueConverter", "tags": [], + "label": "ExpressionValueConverter", "description": [], + "signature": [ + "(input: I, availableTypes: Record) => O" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 17 }, - "signature": [ - "(input: I, availableTypes: Record) => O" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionValueError", "type": "Type", - "label": "ExpressionValueError", "tags": [], + "label": "ExpressionValueError", "description": [], + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "lineNumber": 17 }, - "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionValueFilter", "type": "Type", - "label": "ExpressionValueFilter", "tags": [], + "label": "ExpressionValueFilter", "description": [ "\nRepresents an object that is a Filter." ], + "signature": [ + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "lineNumber": 14 }, - "signature": [ - "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionValueNum", "type": "Type", - "label": "ExpressionValueNum", "tags": [], + "label": "ExpressionValueNum", "description": [], + "signature": [ + "{ type: \"num\"; } & { value: number; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 14 }, - "signature": [ - "{ type: \"num\"; } & { value: number; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionValueRender", "type": "Type", - "label": "ExpressionValueRender", "tags": [], + "label": "ExpressionValueRender", "description": [ "\nRepresents an object that is intended to be rendered." ], + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "lineNumber": 16 }, - "signature": [ - "{ type: \"render\"; } & { as: string; value: T; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionValueUnboxed", "type": "Type", - "label": "ExpressionValueUnboxed", "tags": [], + "label": "ExpressionValueUnboxed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", "lineNumber": 9 }, - "signature": [ - "any" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.FontLabel", "type": "Type", - "label": "FontLabel", "tags": [], + "label": "FontLabel", "description": [ "\nThis type contains a unions of all supported font labels, or the the name of\nthe font the user would see in a UI." ], + "signature": [ + "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 13 }, - "signature": [ - "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.fonts", "type": "Array", + "tags": [], "label": "fonts", "description": [ "\nA collection of supported fonts." ], + "signature": [ + "({ label: \"American Typewriter\"; value: \"'American Typewriter', 'Courier New', Courier, Monaco, mono\"; } | { label: \"Arial\"; value: \"Arial, sans-serif\"; } | { label: \"Baskerville\"; value: \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Book Antiqua\"; value: \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Brush Script\"; value: \"'Brush Script MT', 'Comic Sans', sans-serif\"; } | { label: \"Chalkboard\"; value: \"Chalkboard, 'Comic Sans', sans-serif\"; } | { label: \"Didot\"; value: \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Futura\"; value: \"Futura, Impact, Helvetica, Arial, sans-serif\"; } | { label: \"Gill Sans\"; value: \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Helvetica Neue\"; value: \"'Helvetica Neue', Helvetica, Arial, sans-serif\"; } | { label: \"Hoefler Text\"; value: \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\"; } | { label: \"Lucida Grande\"; value: \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Myriad\"; value: \"Myriad, Helvetica, Arial, sans-serif\"; } | { label: \"Open Sans\"; value: \"'Open Sans', Helvetica, Arial, sans-serif\"; } | { label: \"Optima\"; value: \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Palatino\"; value: \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; })[]" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 123 }, - "signature": [ - "({ label: \"American Typewriter\"; value: \"'American Typewriter', 'Courier New', Courier, Monaco, mono\"; } | { label: \"Arial\"; value: \"Arial, sans-serif\"; } | { label: \"Baskerville\"; value: \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Book Antiqua\"; value: \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Brush Script\"; value: \"'Brush Script MT', 'Comic Sans', sans-serif\"; } | { label: \"Chalkboard\"; value: \"Chalkboard, 'Comic Sans', sans-serif\"; } | { label: \"Didot\"; value: \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Futura\"; value: \"Futura, Impact, Helvetica, Arial, sans-serif\"; } | { label: \"Gill Sans\"; value: \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Helvetica Neue\"; value: \"'Helvetica Neue', Helvetica, Arial, sans-serif\"; } | { label: \"Hoefler Text\"; value: \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\"; } | { label: \"Lucida Grande\"; value: \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Myriad\"; value: \"Myriad, Helvetica, Arial, sans-serif\"; } | { label: \"Open Sans\"; value: \"'Open Sans', Helvetica, Arial, sans-serif\"; } | { label: \"Optima\"; value: \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Palatino\"; value: \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; })[]" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.FontValue", "type": "Type", - "label": "FontValue", "tags": [], + "label": "FontValue", "description": [ "\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property." ], + "signature": [ + "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 19 }, - "signature": [ - "\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.functionSpecs", "type": "Array", + "tags": [], "label": "functionSpecs", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/index.ts", - "lineNumber": 21 - }, "signature": [ { "pluginId": "expressions", @@ -27255,82 +30646,93 @@ }, "[]" ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/index.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.InferFunctionDefinition", "type": "Type", - "label": "InferFunctionDefinition", "tags": [], + "label": "InferFunctionDefinition", "description": [], + "signature": [ + "FnDef extends ExpressionFunctionDefinition ? { name: Name; input: Input; arguments: Arguments; output: Output; context: Context; } : never" + ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 24 }, - "signature": [ - "FnDef extends ExpressionFunctionDefinition ? { name: Name; input: Input; arguments: Arguments; output: Output; context: Context; } : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.InterpreterErrorType", "type": "Type", - "label": "InterpreterErrorType", "tags": [ "deprecated" ], + "label": "InterpreterErrorType", "description": [], + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "lineNumber": 33 }, - "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" - ], + "deprecated": true, + "references": [], "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.KnownTypeToString", "type": "Type", - "label": "KnownTypeToString", "tags": [], + "label": "KnownTypeToString", "description": [ "\nMap the type of the generic to a string-based representation of the type.\n\nIf the provided generic is its own type interface, we use the value of\nthe `type` key as a string literal type for it." ], + "signature": [ + "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", "lineNumber": 26 }, - "signature": [ - "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.MathArguments", "type": "Type", - "label": "MathArguments", "tags": [], + "label": "MathArguments", "description": [], + "signature": [ + "{ expression: string; onError?: \"null\" | \"false\" | \"zero\" | \"throw\" | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 15 }, - "signature": [ - "{ expression: string; onError?: \"null\" | \"false\" | \"zero\" | \"throw\" | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.MathInput", "type": "Type", - "label": "MathInput", "tags": [], + "label": "MathInput", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", - "lineNumber": 20 - }, "signature": [ "number | ", { @@ -27341,54 +30743,60 @@ "text": "Datatable" } ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.PointSeries", "type": "Type", - "label": "PointSeries", "tags": [], + "label": "PointSeries", "description": [ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], + "signature": [ + "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 39 }, - "signature": [ - "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.PointSeriesColumnName", "type": "Type", - "label": "PointSeriesColumnName", "tags": [], + "label": "PointSeriesColumnName", "description": [ "\nAllowed column names in a PointSeries" ], + "signature": [ + "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 18 }, - "signature": [ - "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.PointSeriesColumns", "type": "Type", - "label": "PointSeriesColumns", "tags": [], + "label": "PointSeriesColumns", "description": [ "\nRepresents a collection of valid Columns in a PointSeries" ], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 32 - }, "signature": [ "{} | Record<", { @@ -27408,97 +30816,286 @@ }, ">" ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 32 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.PointSeriesRow", "type": "Type", - "label": "PointSeriesRow", "tags": [], + "label": "PointSeriesRow", "description": [], + "signature": [ + "{ [x: string]: any; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 34 }, - "signature": [ - "{ [x: string]: any; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.Render", "type": "Type", - "label": "Render", "tags": [ "deprecated" ], + "label": "Render", "description": [], + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "lineNumber": 29 }, - "signature": [ - "{ type: \"render\"; } & { as: string; value: T; }" + "deprecated": true, + "references": [ + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/types/state.ts", + "lineNumber": 15 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/types/state.ts", + "lineNumber": 58 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/target/types/types/state.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/target/types/types/state.d.ts", + "lineNumber": 29 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts", + "lineNumber": 10 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts", + "lineNumber": 34 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts", + "lineNumber": 9 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts", + "lineNumber": 21 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/public/functions/pie.ts", + "lineNumber": 15 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/public/functions/pie.ts", + "lineNumber": 78 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/progress.ts", + "lineNumber": 10 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/progress.ts", + "lineNumber": 43 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/repeat_image.ts", + "lineNumber": 11 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/repeat_image.ts", + "lineNumber": 33 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/public/functions/plot/index.ts", + "lineNumber": 18 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/public/functions/plot/index.ts", + "lineNumber": 32 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/metric.ts", + "lineNumber": 9 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/metric.ts", + "lineNumber": 25 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/render.ts", + "lineNumber": 9 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/render.ts", + "lineNumber": 24 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/render.ts", + "lineNumber": 26 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/table.ts", + "lineNumber": 9 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/table.ts", + "lineNumber": 25 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/target/types/canvas_plugin_src/functions/browser/markdown.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "canvas", + "link": { + "path": "x-pack/plugins/canvas/target/types/canvas_plugin_src/functions/browser/markdown.d.ts", + "lineNumber": 13 + } + } ], "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.RenderMode", "type": "Type", - "label": "RenderMode", "tags": [], + "label": "RenderMode", "description": [ "\nMode of the expression render environment.\nThis value can be set from a consumer embedding an expression renderer and is accessible\nfrom within the active render function as part of the handlers.\nThe following modes are supported:\n* display (default): The chart is rendered in a container with the main purpose of viewing the chart (e.g. in a container like dashboard or canvas)\n* preview: The chart is rendered in very restricted space (below 100px width and height) and should only show a rough outline\n* edit: The chart is rendered within an editor and configuration elements within the chart should be displayed\n* noInteractivity: The chart is rendered in a non-interactive environment and should not provide any affordances for interaction like brushing" ], + "signature": [ + "\"display\" | \"noInteractivity\" | \"edit\" | \"preview\"" + ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 61 }, - "signature": [ - "\"display\" | \"noInteractivity\" | \"edit\" | \"preview\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.SerializedError", "type": "Type", - "label": "SerializedError", "tags": [], + "label": "SerializedError", "description": [], + "signature": [ + "{ name: string; message: string; stack?: string | undefined; }" + ], "source": { "path": "src/plugins/expressions/common/util/create_error.ts", "lineNumber": 11 }, - "signature": [ - "{ name: string; message: string; stack?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.Style", "type": "Type", - "label": "Style", "tags": [], + "label": "Style", "description": [], + "signature": [ + "ExpressionTypeStyle" + ], "source": { "path": "src/plugins/expressions/common/types/style.ts", "lineNumber": 126 }, - "signature": [ - "ExpressionTypeStyle" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.typeSpecs", "type": "Array", + "tags": [], "label": "typeSpecs", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/index.ts", - "lineNumber": 25 - }, "signature": [ { "pluginId": "expressions", @@ -27509,37 +31106,41 @@ }, "[]" ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/index.ts", + "lineNumber": 25 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.TypeString", "type": "Type", - "label": "TypeString", "tags": [], + "label": "TypeString", "description": [ "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" ], + "signature": [ + "(T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends string ? \"string\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends boolean ? \"boolean\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends number ? \"number\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends null ? \"null\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends { type: string; } ? ({ type: string; } & (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn))[\"type\"] : never" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", "lineNumber": 39 }, - "signature": [ - "UnwrapPromiseOrReturn extends string ? \"string\" : UnwrapPromiseOrReturn extends boolean ? \"boolean\" : UnwrapPromiseOrReturn extends number ? \"number\" : UnwrapPromiseOrReturn extends null ? \"null\" : UnwrapPromiseOrReturn extends { type: string; } ? ({ type: string; } & UnwrapPromiseOrReturn)[\"type\"] : never" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.TypeToString", "type": "Type", - "label": "TypeToString", "tags": [], + "label": "TypeToString", "description": [ "\nThis can convert a type into a known Expression string representation of\nthat type. For example, `TypeToString` will resolve to `'datatable'`.\nThis allows Expression Functions to continue to specify their type in a\nsimple string format." ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 17 - }, "signature": [ "\"date\" | \"filter\" | ", { @@ -27551,221 +31152,256 @@ }, "" ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 17 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.UnmappedTypeStrings", "type": "Type", - "label": "UnmappedTypeStrings", "tags": [], + "label": "UnmappedTypeStrings", "description": [ "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 46 - }, "signature": [ "\"date\" | \"filter\"" ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 48 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.americanTypewriter", "type": "Object", + "tags": [], "label": "americanTypewriter", "description": [], + "signature": [ + "{ label: \"American Typewriter\"; value: \"'American Typewriter', 'Courier New', Courier, Monaco, mono\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 42 }, - "signature": [ - "{ label: \"American Typewriter\"; value: \"'American Typewriter', 'Courier New', Courier, Monaco, mono\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.arial", "type": "Object", + "tags": [], "label": "arial", "description": [], + "signature": [ + "{ label: \"Arial\"; value: \"Arial, sans-serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 47 }, - "signature": [ - "{ label: \"Arial\"; value: \"Arial, sans-serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.baskerville", "type": "Object", + "tags": [], "label": "baskerville", "description": [], + "signature": [ + "{ label: \"Baskerville\"; value: \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 49 }, - "signature": [ - "{ label: \"Baskerville\"; value: \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.bookAntiqua", "type": "Object", + "tags": [], "label": "bookAntiqua", "description": [], + "signature": [ + "{ label: \"Book Antiqua\"; value: \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 54 }, - "signature": [ - "{ label: \"Book Antiqua\"; value: \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.boolean", "type": "Object", "tags": [], + "label": "boolean", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.boolean.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"boolean\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "lineNumber": 16 }, - "signature": [ - "\"boolean\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.boolean.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.boolean.from.null", "type": "Function", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => false" ], - "description": [], - "label": "null", "source": { "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "lineNumber": 18 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.boolean.from.number", "type": "Function", + "tags": [], + "label": "number", + "description": [], + "signature": [ + "(n: any) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.boolean.from.number.$1", "type": "Any", + "tags": [], "label": "n", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(n: any) => boolean" - ], - "description": [], - "label": "number", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", - "lineNumber": 19 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.boolean.from.string", "type": "Function", + "tags": [], + "label": "string", + "description": [], + "signature": [ + "(s: any) => boolean" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.boolean.from.string.$1", "type": "Any", + "tags": [], "label": "s", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(s: any) => boolean" - ], - "description": [], - "label": "string", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", - "lineNumber": 20 - }, - "tags": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", - "lineNumber": 17 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.boolean.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.boolean.to.render", "type": "Function", - "children": [ - { - "id": "def-common.boolean.to.render.$1", - "type": "boolean", - "label": "value", - "isRequired": true, - "signature": [ - "boolean" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", - "lineNumber": 23 - } - } - ], + "tags": [], + "label": "render", + "description": [], "signature": [ "(value: boolean) => ", { @@ -27777,34 +31413,39 @@ }, "<\"render\", { as: string; value: { text: string; }; }>" ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "lineNumber": 23 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.boolean.to.datatable", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.boolean.to.datatable.$1", + "parentPluginId": "expressions", + "id": "def-common.boolean.to.render.$1", "type": "boolean", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", - "lineNumber": 31 - } + "lineNumber": 23 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.boolean.to.datatable", + "type": "Function", + "tags": [], + "label": "datatable", + "description": [], "signature": [ "(value: boolean) => ", { @@ -27815,441 +31456,520 @@ "text": "Datatable" } ], - "description": [], - "label": "datatable", "source": { "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "lineNumber": 31 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.boolean.to.datatable.$1", + "type": "boolean", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "boolean" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 31 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", - "lineNumber": 22 - } + ] } ], - "description": [], - "label": "boolean", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.brushScript", "type": "Object", + "tags": [], "label": "brushScript", "description": [], + "signature": [ + "{ label: \"Brush Script\"; value: \"'Brush Script MT', 'Comic Sans', sans-serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 59 }, - "signature": [ - "{ label: \"Brush Script\"; value: \"'Brush Script MT', 'Comic Sans', sans-serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.chalkboard", "type": "Object", + "tags": [], "label": "chalkboard", "description": [], + "signature": [ + "{ label: \"Chalkboard\"; value: \"Chalkboard, 'Comic Sans', sans-serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 64 }, - "signature": [ - "{ label: \"Chalkboard\"; value: \"Chalkboard, 'Comic Sans', sans-serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.clog", "type": "Object", "tags": [], + "label": "clog", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.clog.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"clog\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", "lineNumber": 14 }, - "signature": [ - "\"clog\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.clog.args", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "args", + "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "children": [] }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.clog.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.clog.fn", "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(input: unknown) => unknown" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.clog.fn.$1", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(input: unknown) => unknown" - ], - "description": [], - "label": "fn", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", - "lineNumber": 17 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "clog", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.cumulativeSum", "type": "Object", "tags": [], + "label": "cumulativeSum", + "description": [ + "\nCalculates the cumulative sum of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate cumulative sum will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the cumulative sum of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Cumulative sums always start with 0, a cell will contain its own value plus the values of\n all cells of the same series further up in the table.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If the row value contains `null` or `undefined`, it will be ignored and overwritten with the cumulative sum of\n all cells of the same series further up in the table.\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's added to the\n cumulative sum of the current series - if this results in `NaN` (like in case of objects), all cells of the\n current series will be set to `NaN`.\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison.\n Missing values (`null` and `undefined`) will be treated as empty strings." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"cumulative_sum\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 56 }, - "signature": [ - "\"cumulative_sum\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"datatable\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 57 }, - "signature": [ - "\"datatable\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"datatable\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 59 }, - "signature": [ - "\"datatable\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 61 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by", "type": "Object", "tags": [], + "label": "by", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 66 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 67 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by.multi", "type": "boolean", + "tags": [], "label": "multi", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 70 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 71 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 72 }, - "signature": [ - "false" - ] + "deprecated": false } - ], - "description": [], - "label": "by", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", - "lineNumber": 66 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.inputColumnId", "type": "Object", "tags": [], + "label": "inputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.inputColumnId.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 75 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.inputColumnId.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 78 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.inputColumnId.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 79 }, - "signature": [ - "true" - ] + "deprecated": false } - ], - "description": [], - "label": "inputColumnId", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", - "lineNumber": 74 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnId", "type": "Object", "tags": [], + "label": "outputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 81 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnId.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 82 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnId.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 85 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnId.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 86 }, - "signature": [ - "true" - ] + "deprecated": false } - ], - "description": [], - "label": "outputColumnId", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", - "lineNumber": 81 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnName", "type": "Object", "tags": [], + "label": "outputColumnName", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 88 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnName.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 89 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnName.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 92 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnName.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 93 }, - "signature": [ - "false" - ] + "deprecated": false } - ], - "description": [], - "label": "outputColumnName", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", - "lineNumber": 88 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", - "lineNumber": 65 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: ", { @@ -28276,13 +31996,19 @@ "text": "Datatable" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 97 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.fn.$1", "type": "Object", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -28292,17 +32018,20 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 97 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.cumulativeSum.fn.$2", "type": "Object", + "tags": [], "label": "{ by, inputColumnId, outputColumnId, outputColumnName }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -28312,106 +32041,91 @@ "text": "CumulativeSumArgs" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 97 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", - "lineNumber": 97 - } + "returnComment": [] } ], - "description": [ - "\nCalculates the cumulative sum of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate cumulative sum will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the cumulative sum of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Cumulative sums always start with 0, a cell will contain its own value plus the values of\n all cells of the same series further up in the table.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If the row value contains `null` or `undefined`, it will be ignored and overwritten with the cumulative sum of\n all cells of the same series further up in the table.\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's added to the\n cumulative sum of the current series - if this results in `NaN` (like in case of objects), all cells of the\n current series will be set to `NaN`.\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison.\n Missing values (`null` and `undefined`) will be treated as empty strings." - ], - "label": "cumulativeSum", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", - "lineNumber": 55 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.datatable", "type": "Object", "tags": [], + "label": "datatable", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 115 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.datatable.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"datatable\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 116 }, - "signature": [ - "\"datatable\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.datatable.validate", "type": "Function", + "tags": [], + "label": "validate", + "description": [], + "signature": [ + "(table: any) => void" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 117 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.datatable.validate.$1", "type": "Any", + "tags": [], "label": "table", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 117 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(table: any) => void" - ], - "description": [], - "label": "validate", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 117 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.datatable.serialize", "type": "Function", - "children": [ - { - "id": "def-common.datatable.serialize.$1", - "type": "Object", - "label": "table", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 127 - } - } - ], + "tags": [], + "label": "serialize", + "description": [], "signature": [ "(table: ", { @@ -28431,40 +32145,45 @@ }, "[]; }" ], - "description": [], - "label": "serialize", "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 127 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.datatable.deserialize", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.datatable.deserialize.$1", + "parentPluginId": "expressions", + "id": "def-common.datatable.serialize.$1", "type": "Object", + "tags": [], "label": "table", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedDatatable", - "text": "SerializedDatatable" + "section": "def-common.Datatable", + "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 136 - } + "lineNumber": 127 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.datatable.deserialize", + "type": "Function", + "tags": [], + "label": "deserialize", + "description": [], "signature": [ "(table: ", { @@ -28484,45 +32203,108 @@ }, "[]; }" ], - "description": [], - "label": "deserialize", "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 136 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.datatable.from", - "type": "Object", - "tags": [], + "deprecated": false, "children": [ { - "id": "def-common.datatable.from.null", - "type": "Function", - "children": [], - "signature": [ - "() => { type: \"datatable\"; meta: {}; rows: never[]; columns: never[]; }" - ], - "description": [], + "parentPluginId": "expressions", + "id": "def-common.datatable.deserialize.$1", + "type": "Object", + "tags": [], + "label": "table", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedDatatable", + "text": "SerializedDatatable" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 136 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.datatable.from", + "type": "Object", + "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 145 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.datatable.from.null", + "type": "Function", + "tags": [], "label": "null", + "description": [], + "signature": [ + "() => { type: \"datatable\"; meta: {}; rows: never[]; columns: never[]; }" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 146 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.datatable.from.pointseries", "type": "Function", + "tags": [], + "label": "pointseries", + "description": [], + "signature": [ + "(value: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"pointseries\", { columns: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumns", + "text": "PointSeriesColumns" + }, + "; rows: Record[]; }>) => { type: \"datatable\"; meta: {}; rows: Record[]; columns: { id: string; name: string; meta: { type: \"string\" | \"number\"; }; }[]; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 152 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.datatable.from.pointseries.$1", "type": "CompoundType", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -28541,79 +32323,38 @@ }, "; rows: Record[]; }>" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 152 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"pointseries\", { columns: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.PointSeriesColumns", - "text": "PointSeriesColumns" - }, - "; rows: Record[]; }>) => { type: \"datatable\"; meta: {}; rows: Record[]; columns: { id: string; name: string; meta: { type: \"string\" | \"number\"; }; }[]; }" - ], - "description": [], - "label": "pointseries", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 152 - }, - "tags": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 145 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.datatable.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 161 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.datatable.to.render", "type": "Function", - "children": [ - { - "id": "def-common.datatable.to.render.$1", - "type": "Object", - "label": "table", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 162 - } - } - ], + "tags": [], + "label": "render", + "description": [], "signature": [ "(table: ", { @@ -28633,24 +32374,19 @@ }, "<\"render\", { as: string; value: RenderedDatatable; }>" ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 162 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.datatable.to.pointseries", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.datatable.to.pointseries.$1", + "parentPluginId": "expressions", + "id": "def-common.datatable.to.render.$1", "type": "Object", + "tags": [], "label": "table", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -28660,13 +32396,23 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 172 - } + "lineNumber": 162 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.datatable.to.pointseries", + "type": "Function", + "tags": [], + "label": "pointseries", + "description": [], "signature": [ "(table: ", { @@ -28694,379 +32440,455 @@ }, "; rows: Record[]; }>" ], - "description": [], - "label": "pointseries", "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 172 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.datatable.to.pointseries.$1", + "type": "Object", + "tags": [], + "label": "table", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 172 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 161 - } + ] } ], - "description": [], - "label": "datatable", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", - "lineNumber": 115 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.defaultState", "type": "Object", "tags": [], + "label": "defaultState", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.defaultState.functions", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "functions", + "description": [], "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "children": [] }, { + "parentPluginId": "expressions", "id": "def-common.defaultState.types", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "types", + "description": [], "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "children": [] }, { + "parentPluginId": "expressions", "id": "def-common.defaultState.context", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "context", + "description": [], "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "children": [] } ], - "description": [], - "label": "defaultState", - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.derivative", "type": "Object", "tags": [], + "label": "derivative", + "description": [ + "\nCalculates the derivative of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate derivative will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the derivative of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Derivative always start with an undefined value for the first row of a series, a cell will contain its own value minus the\n value of the previous cell of the same series.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If there is no previous row of the current series with a non `null` or `undefined` value, the output cell of the current row\n will be set to `undefined`.\n* If the row value contains `null` or `undefined`, it will be ignored and the output cell will be set to `undefined`\n* If the value of the previous row of the same series contains `null` or `undefined`, the output cell of the current row will be set to `undefined` as well\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's used in the\n calculation of the current series even if this results in `NaN` (like in case of objects).\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison.\n Missing values (`null` and `undefined`) will be treated as empty strings." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"derivative\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 57 }, - "signature": [ - "\"derivative\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"datatable\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 58 }, - "signature": [ - "\"datatable\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"datatable\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 60 }, - "signature": [ - "\"datatable\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 62 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.derivative.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 66 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.derivative.args.by", "type": "Object", "tags": [], + "label": "by", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 67 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.by.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 68 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.by.multi", "type": "boolean", + "tags": [], "label": "multi", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 71 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.by.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 72 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.by.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 73 }, - "signature": [ - "false" - ] + "deprecated": false } - ], - "description": [], - "label": "by", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", - "lineNumber": 67 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.derivative.args.inputColumnId", "type": "Object", "tags": [], + "label": "inputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 75 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.inputColumnId.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 76 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.inputColumnId.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 79 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.inputColumnId.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 80 }, - "signature": [ - "true" - ] + "deprecated": false } - ], - "description": [], - "label": "inputColumnId", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", - "lineNumber": 75 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnId", "type": "Object", "tags": [], + "label": "outputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 82 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnId.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 83 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnId.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 86 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnId.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 87 }, - "signature": [ - "true" - ] + "deprecated": false } - ], - "description": [], - "label": "outputColumnId", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", - "lineNumber": 82 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnName", "type": "Object", "tags": [], + "label": "outputColumnName", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 89 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnName.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 90 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnName.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 93 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnName.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 94 }, - "signature": [ - "false" - ] + "deprecated": false } - ], - "description": [], - "label": "outputColumnName", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", - "lineNumber": 89 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", - "lineNumber": 66 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.derivative.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: ", { @@ -29093,13 +32915,19 @@ "text": "Datatable" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.derivative.fn.$1", "type": "Object", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -29109,17 +32937,20 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 98 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.derivative.fn.$2", "type": "Object", + "tags": [], "label": "{ by, inputColumnId, outputColumnId, outputColumnName }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -29129,112 +32960,85 @@ "text": "DerivativeArgs" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 98 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", - "lineNumber": 98 - } + "returnComment": [] } ], - "description": [ - "\nCalculates the derivative of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate derivative will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the derivative of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Derivative always start with an undefined value for the first row of a series, a cell will contain its own value minus the\n value of the previous cell of the same series.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If there is no previous row of the current series with a non `null` or `undefined` value, the output cell of the current row\n will be set to `undefined`.\n* If the row value contains `null` or `undefined`, it will be ignored and the output cell will be set to `undefined`\n* If the value of the previous row of the same series contains `null` or `undefined`, the output cell of the current row will be set to `undefined` as well\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's used in the\n calculation of the current series even if this results in `NaN` (like in case of objects).\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison.\n Missing values (`null` and `undefined`) will be treated as empty strings." - ], - "label": "derivative", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", - "lineNumber": 56 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.didot", "type": "Object", + "tags": [], "label": "didot", "description": [], + "signature": [ + "{ label: \"Didot\"; value: \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 69 }, - "signature": [ - "{ label: \"Didot\"; value: \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.error", "type": "Object", "tags": [], + "label": "error", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.error.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"error\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "lineNumber": 36 }, - "signature": [ - "\"error\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.error.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.error.to.render", "type": "Function", - "children": [ - { - "id": "def-common.error.to.render.$1", - "type": "CompoundType", - "label": "input", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"error\", { error: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ErrorLike", - "text": "ErrorLike" - }, - "; info?: ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, - " | undefined; }>" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/error.ts", - "lineNumber": 38 - } - } - ], + "tags": [], + "label": "render", + "description": [], "signature": [ "(input: ", { @@ -29277,63 +33081,80 @@ "text": "ExpressionValueBoxed" } ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "lineNumber": 38 }, - "tags": [], - "returnComment": [] - } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/error.ts", - "lineNumber": 37 - } + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.error.to.render.$1", + "type": "CompoundType", + "tags": [], + "label": "input", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"error\", { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }>" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 38 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ] } ], - "description": [], - "label": "error", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/error.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.executionPureTransitions", "type": "Object", "tags": [], + "label": "executionPureTransitions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.executionPureTransitions.start", "type": "Function", - "children": [ - { - "id": "def-common.executionPureTransitions.start.$1", - "type": "Object", - "label": "state", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" - }, - "" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 57 - } - } - ], + "tags": [], + "label": "start", + "description": [], "signature": [ "(state: ", { @@ -29369,24 +33190,19 @@ }, ">; context: Record; }" ], - "description": [], - "label": "start", "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 57 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.executionPureTransitions.setResult", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.executionPureTransitions.setResult.$1", + "parentPluginId": "expressions", + "id": "def-common.executionPureTransitions.start.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -29397,13 +33213,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 61 - } + "lineNumber": 57 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.executionPureTransitions.setResult", + "type": "Function", + "tags": [], + "label": "setResult", + "description": [], "signature": [ "(state: ", { @@ -29439,24 +33265,19 @@ }, ">; context: Record; }" ], - "description": [], - "label": "setResult", "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 61 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.executionPureTransitions.setError", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.executionPureTransitions.setError.$1", + "parentPluginId": "expressions", + "id": "def-common.executionPureTransitions.setResult.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -29467,13 +33288,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 66 - } + "lineNumber": 61 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.executionPureTransitions.setError", + "type": "Function", + "tags": [], + "label": "setError", + "description": [], "signature": [ "(state: ", { @@ -29509,195 +33340,256 @@ }, ">; context: Record; }" ], - "description": [], - "label": "setError", "source": { "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 66 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.executionPureTransitions.setError.$1", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + "" + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 66 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } ], - "description": [], - "label": "executionPureTransitions", - "source": { - "path": "src/plugins/expressions/common/execution/container.ts", - "lineNumber": 56 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.filter", "type": "Object", "tags": [], + "label": "filter", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.filter.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"filter\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "lineNumber": 28 }, - "signature": [ - "\"filter\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.filter.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.filter.from.null", "type": "Function", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => { type: \"filter\"; filterType: string; meta: {}; and: never[]; }" ], - "description": [], - "label": "null", "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", - "lineNumber": 29 - } + ] } ], - "description": [], - "label": "filter", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.font", "type": "Object", "tags": [], + "label": "font", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"font\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 47 }, - "signature": [ - "\"font\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "never[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 48 }, - "signature": [ - "never[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"style\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 49 }, - "signature": [ - "\"style\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 50 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 53 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.font.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.font.args.align", "type": "Object", "tags": [], + "label": "align", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.align.default", "type": "string", + "tags": [], "label": "default", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 56 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.align.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.align.options", "type": "Array", + "tags": [], "label": "options", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 60 - }, "signature": [ { "pluginId": "expressions", @@ -29707,403 +33599,467 @@ "text": "TextAlignment" }, "[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 60 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.align.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 61 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false } - ], - "description": [], - "label": "align", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 55 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.font.args.color", "type": "Object", "tags": [], + "label": "color", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.color.default", "type": "string", + "tags": [], "label": "default", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 64 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.color.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 65 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.color.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 68 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false } - ], - "description": [], - "label": "color", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 63 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.font.args.family", "type": "Object", "tags": [], + "label": "family", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.family.default", "type": "string", + "tags": [], "label": "default", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 71 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.family.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 72 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.family.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 78 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false } - ], - "description": [], - "label": "family", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 70 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.font.args.italic", "type": "Object", "tags": [], + "label": "italic", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.italic.default", "type": "string", + "tags": [], "label": "default", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 81 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.italic.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 82 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.italic.options", "type": "Array", + "tags": [], "label": "options", "description": [], + "signature": [ + "boolean[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 85 }, - "signature": [ - "boolean[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.italic.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"boolean\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 86 }, - "signature": [ - "\"boolean\"[]" - ] + "deprecated": false } - ], - "description": [], - "label": "italic", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 80 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.font.args.lHeight", "type": "Object", "tags": [], + "label": "lHeight", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 88 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.lHeight.default", "type": "string", + "tags": [], "label": "default", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 89 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.lHeight.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 90 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.lHeight.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 91 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.lHeight.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "(\"number\" | \"null\")[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 94 }, - "signature": [ - "(\"number\" | \"null\")[]" - ] + "deprecated": false } - ], - "description": [], - "label": "lHeight", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 88 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.font.args.size", "type": "Object", "tags": [], + "label": "size", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 96 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.size.default", "type": "string", + "tags": [], "label": "default", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 97 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.size.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 98 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.size.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"number\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 101 }, - "signature": [ - "\"number\"[]" - ] + "deprecated": false } - ], - "description": [], - "label": "size", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 96 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.font.args.underline", "type": "Object", "tags": [], + "label": "underline", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 103 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.underline.default", "type": "string", + "tags": [], "label": "default", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 104 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.underline.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 105 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.underline.options", "type": "Array", + "tags": [], "label": "options", "description": [], + "signature": [ + "boolean[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 108 }, - "signature": [ - "boolean[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.underline.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"boolean\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 109 }, - "signature": [ - "\"boolean\"[]" - ] + "deprecated": false } - ], - "description": [], - "label": "underline", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 103 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.font.args.weight", "type": "Object", "tags": [], + "label": "weight", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 111 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.weight.default", "type": "string", + "tags": [], "label": "default", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 112 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.weight.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 113 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.weight.options", "type": "Array", + "tags": [], "label": "options", "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 123 - }, "signature": [ { "pluginId": "expressions", @@ -30113,209 +34069,214 @@ "text": "FontWeight" }, "[]" - ] + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 123 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.font.args.weight.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 124 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false } - ], - "description": [], - "label": "weight", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 111 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 54 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.font.fn", "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(input: null, args: Arguments) => { type: \"style\"; spec: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CSSStyle", + "text": "CSSStyle" + }, + "; css: string; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 127 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.font.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 127 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.font.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 127 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(input: null, args: Arguments) => { type: \"style\"; spec: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.CSSStyle", - "text": "CSSStyle" - }, - "; css: string; }" - ], - "description": [], - "label": "fn", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 127 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "font", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", - "lineNumber": 46 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.futura", "type": "Object", + "tags": [], "label": "futura", "description": [], + "signature": [ + "{ label: \"Futura\"; value: \"Futura, Impact, Helvetica, Arial, sans-serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 74 }, - "signature": [ - "{ label: \"Futura\"; value: \"Futura, Impact, Helvetica, Arial, sans-serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.gillSans", "type": "Object", + "tags": [], "label": "gillSans", "description": [], + "signature": [ + "{ label: \"Gill Sans\"; value: \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 79 }, - "signature": [ - "{ label: \"Gill Sans\"; value: \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.helveticaNeue", "type": "Object", + "tags": [], "label": "helveticaNeue", "description": [], + "signature": [ + "{ label: \"Helvetica Neue\"; value: \"'Helvetica Neue', Helvetica, Arial, sans-serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 85 }, - "signature": [ - "{ label: \"Helvetica Neue\"; value: \"'Helvetica Neue', Helvetica, Arial, sans-serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.hoeflerText", "type": "Object", + "tags": [], "label": "hoeflerText", "description": [], + "signature": [ + "{ label: \"Hoefler Text\"; value: \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 90 }, - "signature": [ - "{ label: \"Hoefler Text\"; value: \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.image", "type": "Object", "tags": [], + "label": "image", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.image.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"image\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 21 }, - "signature": [ - "\"image\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.image.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.image.to.render", "type": "Function", - "children": [ - { - "id": "def-common.image.to.render.$1", - "type": "Object", - "label": "input", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionImage", - "text": "ExpressionImage" - } - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/image.ts", - "lineNumber": 23 - } - } - ], + "tags": [], + "label": "render", + "description": [], "signature": [ "(input: ", { @@ -30343,419 +34304,532 @@ }, ", \"dataurl\" | \"mode\">; }>" ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "lineNumber": 23 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.image.to.render.$1", + "type": "Object", + "tags": [], + "label": "input", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionImage", + "text": "ExpressionImage" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 23 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/image.ts", - "lineNumber": 22 - } + ] } ], - "description": [], - "label": "image", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/image.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.lucidaGrande", "type": "Object", + "tags": [], "label": "lucidaGrande", "description": [], + "signature": [ + "{ label: \"Lucida Grande\"; value: \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 95 }, - "signature": [ - "{ label: \"Lucida Grande\"; value: \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.mapColumn", "type": "Object", "tags": [], + "label": "mapColumn", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"mapColumn\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 26 + "lineNumber": 28 }, - "signature": [ - "\"mapColumn\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 27 + "lineNumber": 29 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"datatable\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 28 + "lineNumber": 30 }, - "signature": [ - "\"datatable\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"datatable\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 29 + "lineNumber": 31 }, - "signature": [ - "\"datatable\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 30 - } + "lineNumber": 32 + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.mapColumn.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id", "type": "Object", "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "(\"string\" | \"null\")[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 42 + "lineNumber": 44 }, - "signature": [ - "(\"string\" | \"null\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 43 - } + "lineNumber": 45 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 47 + "lineNumber": 49 }, - "signature": [ - "false" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id.default", "type": "Uncategorized", + "tags": [], "label": "default", "description": [], + "signature": [ + "null" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 48 + "lineNumber": 50 }, - "signature": [ - "null" - ] + "deprecated": false } - ], - "description": [], - "label": "id", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 41 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name", "type": "Object", "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 52 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 51 + "lineNumber": 53 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 52 + "lineNumber": 54 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 53 - } + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 56 + "lineNumber": 58 }, - "signature": [ - "true" - ] + "deprecated": false } - ], - "description": [], - "label": "name", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 50 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression", "type": "Object", "tags": [], + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "(\"boolean\" | \"string\" | \"number\" | \"null\")[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 59 + "lineNumber": 61 }, - "signature": [ - "(\"boolean\" | \"string\" | \"number\" | \"null\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.resolve", "type": "boolean", + "tags": [], "label": "resolve", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 60 + "lineNumber": 62 }, - "signature": [ - "false" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 61 + "lineNumber": 63 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 62 - } + "lineNumber": 64 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 69 + "lineNumber": 71 }, - "signature": [ - "true" - ] + "deprecated": false } - ], - "description": [], - "label": "expression", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 58 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom", "type": "Object", "tags": [], + "label": "copyMetaFrom", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 73 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "(\"string\" | \"null\")[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 72 + "lineNumber": 74 }, - "signature": [ - "(\"string\" | \"null\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 73 - } + "lineNumber": 75 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 77 + "lineNumber": 79 }, - "signature": [ - "false" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom.default", "type": "Uncategorized", + "tags": [], "label": "default", "description": [], + "signature": [ + "null" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 78 + "lineNumber": 80 }, - "signature": [ - "null" - ] + "deprecated": false } - ], - "description": [], - "label": "copyMetaFrom", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 71 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 40 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.mapColumn.fn", "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", args: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MapColumnArguments", + "text": "MapColumnArguments" + }, + ") => Promise<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ">" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.mapColumn.fn.$1", "type": "Object", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -30765,17 +34839,20 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 81 - } + "lineNumber": 83 + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.mapColumn.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -30785,242 +34862,267 @@ "text": "MapColumnArguments" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 81 - } + "lineNumber": 83 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(input: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - ", args: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.MapColumnArguments", - "text": "MapColumnArguments" - }, - ") => Promise<", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - ">" - ], - "description": [], - "label": "fn", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 81 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "mapColumn", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.math", "type": "Object", "tags": [], + "label": "math", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 79 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.math.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"math\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 85 }, - "signature": [ - "\"math\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.math.type", "type": "Uncategorized", + "tags": [], "label": "type", "description": [], + "signature": [ + "undefined" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 86 }, - "signature": [ - "undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.math.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "(\"number\" | \"datatable\")[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 87 }, - "signature": [ - "(\"number\" | \"datatable\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.math.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 88 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.math.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 101 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.math.args.expression", "type": "Object", "tags": [], + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 102 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.math.args.expression.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 103 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.math.args.expression.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 104 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.math.args.expression.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 105 - } + }, + "deprecated": false } - ], - "description": [], - "label": "expression", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", - "lineNumber": 102 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.math.args.onError", "type": "Object", "tags": [], + "label": "onError", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 113 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.math.args.onError.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 114 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.math.args.onError.options", "type": "Array", + "tags": [], "label": "options", "description": [], + "signature": [ + "(\"null\" | \"false\" | \"zero\" | \"throw\")[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 115 }, - "signature": [ - "(\"null\" | \"false\" | \"zero\" | \"throw\")[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.math.args.onError.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 116 - } + }, + "deprecated": false } - ], - "description": [], - "label": "onError", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", - "lineNumber": 113 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", - "lineNumber": 101 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.math.fn", "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MathInput", + "text": "MathInput" + }, + ", args: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MathArguments", + "text": "MathArguments" + }, + ") => number | false | null" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 125 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.math.fn.$1", "type": "CompoundType", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -31030,17 +35132,20 @@ "text": "MathInput" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 125 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.math.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -31050,396 +35155,430 @@ "text": "MathArguments" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 125 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(input: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.MathInput", - "text": "MathInput" - }, - ", args: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.MathArguments", - "text": "MathArguments" - }, - ") => number | false | null" - ], - "description": [], - "label": "fn", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", - "lineNumber": 125 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "math", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", - "lineNumber": 79 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.movingAverage", "type": "Object", "tags": [], + "label": "movingAverage", + "description": [ + "\nCalculates the moving average of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate moving average will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the moving average of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Moving average always starts with an undefined value for the first row of a series. Each next cell will contain sum of the last\n* [window] of values divided by [window] excluding the current bucket.\nIf either of window edges moves outside the borders of data series, the window shrinks to include available values only.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If null or undefined value is encountered, skip the current row and do not change the window\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's used in the\n calculation of the current series even if this results in `NaN` (like in case of objects).\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"moving_average\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 55 }, - "signature": [ - "\"moving_average\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"datatable\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 56 }, - "signature": [ - "\"datatable\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"datatable\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 58 }, - "signature": [ - "\"datatable\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 60 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.movingAverage.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by", "type": "Object", "tags": [], + "label": "by", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 66 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by.multi", "type": "boolean", + "tags": [], "label": "multi", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 69 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 70 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 71 }, - "signature": [ - "false" - ] + "deprecated": false } - ], - "description": [], - "label": "by", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", - "lineNumber": 65 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.inputColumnId", "type": "Object", "tags": [], + "label": "inputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 73 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.inputColumnId.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 74 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.inputColumnId.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 77 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.inputColumnId.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 78 }, - "signature": [ - "true" - ] + "deprecated": false } - ], - "description": [], - "label": "inputColumnId", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", - "lineNumber": 73 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnId", "type": "Object", "tags": [], + "label": "outputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnId.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 81 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnId.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 84 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnId.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 85 }, - "signature": [ - "true" - ] + "deprecated": false } - ], - "description": [], - "label": "outputColumnId", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", - "lineNumber": 80 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnName", "type": "Object", "tags": [], + "label": "outputColumnName", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 87 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnName.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 88 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnName.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 91 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnName.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 92 }, - "signature": [ - "false" - ] + "deprecated": false } - ], - "description": [], - "label": "outputColumnName", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", - "lineNumber": 87 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.window", "type": "Object", "tags": [], + "label": "window", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 94 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.window.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 95 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.window.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"number\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 98 }, - "signature": [ - "\"number\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.movingAverage.args.window.default", "type": "number", + "tags": [], "label": "default", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 99 - } + }, + "deprecated": false } - ], - "description": [], - "label": "window", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", - "lineNumber": 94 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", - "lineNumber": 64 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.movingAverage.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: ", { @@ -31466,13 +35605,19 @@ "text": "Datatable" } ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 103 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.movingAverage.fn.$1", "type": "Object", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -31482,17 +35627,20 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 103 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.movingAverage.fn.$2", "type": "Object", + "tags": [], "label": "{ by, inputColumnId, outputColumnId, outputColumnName, window }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -31502,275 +35650,291 @@ "text": "MovingAverageArgs" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 103 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", - "lineNumber": 103 - } + "returnComment": [] } ], - "description": [ - "\nCalculates the moving average of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate moving average will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the moving average of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Moving average always starts with an undefined value for the first row of a series. Each next cell will contain sum of the last\n* [window] of values divided by [window] excluding the current bucket.\nIf either of window edges moves outside the borders of data series, the window shrinks to include available values only.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If null or undefined value is encountered, skip the current row and do not change the window\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's used in the\n calculation of the current series even if this results in `NaN` (like in case of objects).\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison." - ], - "label": "movingAverage", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.myriad", "type": "Object", + "tags": [], "label": "myriad", "description": [], + "signature": [ + "{ label: \"Myriad\"; value: \"Myriad, Helvetica, Arial, sans-serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 100 }, - "signature": [ - "{ label: \"Myriad\"; value: \"Myriad, Helvetica, Arial, sans-serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.nullType", "type": "Object", "tags": [], + "label": "nullType", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/null.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.nullType.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"null\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/null.ts", "lineNumber": 14 }, - "signature": [ - "\"null\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.nullType.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/null.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.nullType.from.", "type": "Function", - "children": [], + "tags": [], + "label": "'*'", + "description": [], "signature": [ "() => null" ], - "description": [], - "label": "'*'", "source": { "path": "src/plugins/expressions/common/expression_types/specs/null.ts", "lineNumber": 16 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/null.ts", - "lineNumber": 15 - } + ] } ], - "description": [], - "label": "nullType", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/null.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.num", "type": "Object", "tags": [], + "label": "num", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.num.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"num\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 22 }, - "signature": [ - "\"num\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.num.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.num.from.null", "type": "Function", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => { type: \"num\"; value: number; }" ], - "description": [], - "label": "null", "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.num.from.boolean", "type": "Function", + "tags": [], + "label": "boolean", + "description": [], + "signature": [ + "(b: any) => { type: \"num\"; value: number; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.num.from.boolean.$1", "type": "Any", + "tags": [], "label": "b", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(b: any) => { type: \"num\"; value: number; }" - ], - "description": [], - "label": "boolean", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/num.ts", - "lineNumber": 28 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.num.from.string", "type": "Function", - "children": [ - { - "id": "def-common.num.from.string.$1", - "type": "Any", - "label": "n", - "isRequired": true, - "signature": [ - "any" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/num.ts", - "lineNumber": 32 - } - } - ], + "tags": [], + "label": "string", + "description": [], "signature": [ "(n: any) => { type: \"num\"; value: number; }" ], - "description": [], - "label": "string", "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 32 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.num.from.string.$1", + "type": "Any", + "tags": [], + "label": "n", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 32 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.num.from.", "type": "Function", + "tags": [], + "label": "'*'", + "description": [], + "signature": [ + "(value: any) => { type: \"num\"; value: number; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.num.from..$1", "type": "Any", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: any) => { type: \"num\"; value: number; }" - ], - "description": [], - "label": "'*'", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/num.ts", - "lineNumber": 49 - }, - "tags": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/num.ts", - "lineNumber": 23 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.num.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.num.to.render", "type": "Function", - "children": [ - { - "id": "def-common.num.to.render.$1", - "type": "CompoundType", - "label": "{ value }", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"num\", { value: number; }>" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/num.ts", - "lineNumber": 55 - } - } - ], + "tags": [], + "label": "render", + "description": [], "signature": [ "({ value }: ", { @@ -31790,24 +35954,19 @@ }, "<\"render\", { as: string; value: { text: string; }; }>" ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 55 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.num.to.datatable", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.num.to.datatable.$1", + "parentPluginId": "expressions", + "id": "def-common.num.to.render.$1", "type": "CompoundType", + "tags": [], "label": "{ value }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -31818,13 +35977,23 @@ }, "<\"num\", { value: number; }>" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", - "lineNumber": 63 - } + "lineNumber": 55 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.num.to.datatable", + "type": "Function", + "tags": [], + "label": "datatable", + "description": [], "signature": [ "({ value }: ", { @@ -31843,166 +36012,198 @@ "text": "Datatable" } ], - "description": [], - "label": "datatable", "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 63 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.num.to.datatable.$1", + "type": "CompoundType", + "tags": [], + "label": "{ value }", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"num\", { value: number; }>" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 63 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/num.ts", - "lineNumber": 54 - } + ] } ], - "description": [], - "label": "num", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/num.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.number", "type": "Object", "tags": [], + "label": "number", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.number.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"number\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "lineNumber": 17 }, - "signature": [ - "\"number\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.number.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.number.from.null", "type": "Function", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => number" ], - "description": [], - "label": "null", "source": { "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "lineNumber": 19 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.number.from.boolean", "type": "Function", + "tags": [], + "label": "boolean", + "description": [], + "signature": [ + "(b: any) => number" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.number.from.boolean.$1", "type": "Any", + "tags": [], "label": "b", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(b: any) => number" - ], - "description": [], - "label": "boolean", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/number.ts", - "lineNumber": 20 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.number.from.string", "type": "Function", + "tags": [], + "label": "string", + "description": [], + "signature": [ + "(n: any) => number" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.number.from.string.$1", "type": "Any", + "tags": [], "label": "n", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(n: any) => number" - ], - "description": [], - "label": "string", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/number.ts", - "lineNumber": 21 - }, - "tags": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/number.ts", - "lineNumber": 18 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.number.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.number.to.render", "type": "Function", - "children": [ - { - "id": "def-common.number.to.render.$1", - "type": "number", - "label": "value", - "isRequired": true, - "signature": [ - "number" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/number.ts", - "lineNumber": 37 - } - } - ], + "tags": [], + "label": "render", + "description": [], "signature": [ "(value: number) => ", { @@ -32014,34 +36215,39 @@ }, "<\"render\", { as: string; value: { text: string; }; }>" ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "lineNumber": 37 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.number.to.datatable", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.number.to.datatable.$1", + "parentPluginId": "expressions", + "id": "def-common.number.to.render.$1", "type": "number", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "number" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/number.ts", - "lineNumber": 45 - } + "lineNumber": 37 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.number.to.datatable", + "type": "Function", + "tags": [], + "label": "datatable", + "description": [], "signature": [ "(value: number) => ", { @@ -32052,178 +36258,170 @@ "text": "Datatable" } ], - "description": [], - "label": "datatable", "source": { "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "lineNumber": 45 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.number.to.datatable.$1", + "type": "number", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "number" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 45 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/number.ts", - "lineNumber": 36 - } + ] } ], - "description": [], - "label": "number", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/number.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.openSans", "type": "Object", + "tags": [], "label": "openSans", "description": [], + "signature": [ + "{ label: \"Open Sans\"; value: \"'Open Sans', Helvetica, Arial, sans-serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 105 }, - "signature": [ - "{ label: \"Open Sans\"; value: \"'Open Sans', Helvetica, Arial, sans-serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.optima", "type": "Object", + "tags": [], "label": "optima", "description": [], + "signature": [ + "{ label: \"Optima\"; value: \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 110 }, - "signature": [ - "{ label: \"Optima\"; value: \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.palatino", "type": "Object", + "tags": [], "label": "palatino", "description": [], + "signature": [ + "{ label: \"Palatino\"; value: \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; }" + ], "source": { "path": "src/plugins/expressions/common/fonts.ts", "lineNumber": 115 }, - "signature": [ - "{ label: \"Palatino\"; value: \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.pointseries", "type": "Object", "tags": [], + "label": "pointseries", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.pointseries.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"pointseries\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 48 }, - "signature": [ - "\"pointseries\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.pointseries.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.pointseries.from.null", "type": "Function", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => { type: \"pointseries\"; rows: never[]; columns: {}; }" ], - "description": [], - "label": "null", "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 50 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 49 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.pointseries.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 58 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.pointseries.to.render", "type": "Function", - "children": [ - { - "id": "def-common.pointseries.to.render.$1", - "type": "CompoundType", - "label": "pseries", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"pointseries\", { columns: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.PointSeriesColumns", - "text": "PointSeriesColumns" - }, - "; rows: Record[]; }>" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 60 - } - }, - { - "id": "def-common.pointseries.to.render.$2", - "type": "Object", - "label": "types", - "isRequired": true, - "signature": [ - "Record" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 61 - } - } - ], + "tags": [], + "label": "render", + "description": [], "signature": [ "(pseries: ", { @@ -32259,63 +36457,89 @@ }, "; showHeader: boolean; }; }>" ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "lineNumber": 59 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.pointseries.to.render.$1", + "type": "CompoundType", + "tags": [], + "label": "pseries", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"pointseries\", { columns: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumns", + "text": "PointSeriesColumns" + }, + "; rows: Record[]; }>" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 60 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-common.pointseries.to.render.$2", + "type": "Object", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "Record" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 61 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 58 - } + ] } ], - "description": [], - "label": "pointseries", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", - "lineNumber": 47 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.pureSelectors", "type": "Object", "tags": [], + "label": "pureSelectors", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.pureSelectors.getFunction", "type": "Function", - "children": [ - { - "id": "def-common.pureSelectors.getFunction.$1", - "type": "Object", - "label": "state", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - ">" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 50 - } - } - ], + "tags": [], + "label": "getFunction", + "description": [], "signature": [ "(state: ", { @@ -32334,24 +36558,19 @@ "text": "ExpressionFunction" } ], - "description": [], - "label": "getFunction", "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 50 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.pureSelectors.getType", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.pureSelectors.getType.$1", + "parentPluginId": "expressions", + "id": "def-common.pureSelectors.getFunction.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -32362,13 +36581,23 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 51 - } + "lineNumber": 50 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.pureSelectors.getType", + "type": "Function", + "tags": [], + "label": "getType", + "description": [], "signature": [ "(state: ", { @@ -32387,24 +36616,19 @@ "text": "ExpressionType" } ], - "description": [], - "label": "getType", "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 51 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.pureSelectors.getContext", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.pureSelectors.getContext.$1", + "parentPluginId": "expressions", + "id": "def-common.pureSelectors.getType.$1", "type": "Object", - "label": "{ context }", - "isRequired": true, + "tags": [], + "label": "state", + "description": [], "signature": [ { "pluginId": "expressions", @@ -32415,13 +36639,23 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 52 - } + "lineNumber": 51 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.pureSelectors.getContext", + "type": "Function", + "tags": [], + "label": "getContext", + "description": [], "signature": [ "({ context }: ", { @@ -32433,38 +36667,19 @@ }, ">) => () => Record" ], - "description": [], - "label": "getContext", "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 52 }, - "tags": [], - "returnComment": [] - } - ], - "description": [], - "label": "pureSelectors", - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 49 - }, - "initialIsOpen": false - }, - { - "id": "def-common.pureTransitions", - "type": "Object", - "tags": [], - "children": [ - { - "id": "def-common.pureTransitions.addFunction", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.pureTransitions.addFunction.$1", + "parentPluginId": "expressions", + "id": "def-common.pureSelectors.getContext.$1", "type": "Object", - "label": "state", - "isRequired": true, + "tags": [], + "label": "{ context }", + "description": [], "signature": [ { "pluginId": "expressions", @@ -32475,13 +36690,39 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 35 - } + "lineNumber": 52 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.pureTransitions", + "type": "Object", + "tags": [], + "label": "pureTransitions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 34 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.pureTransitions.addFunction", + "type": "Function", + "tags": [], + "label": "addFunction", + "description": [], "signature": [ "(state: ", { @@ -32517,24 +36758,19 @@ }, ">; context: Record; }" ], - "description": [], - "label": "addFunction", "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 35 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.pureTransitions.addType", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.pureTransitions.addType.$1", + "parentPluginId": "expressions", + "id": "def-common.pureTransitions.addFunction.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -32545,13 +36781,23 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 36 - } + "lineNumber": 35 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.pureTransitions.addType", + "type": "Function", + "tags": [], + "label": "addType", + "description": [], "signature": [ "(state: ", { @@ -32587,24 +36833,19 @@ }, ">; context: Record; }" ], - "description": [], - "label": "addType", "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 36 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.pureTransitions.extendContext", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.pureTransitions.extendContext.$1", + "parentPluginId": "expressions", + "id": "def-common.pureTransitions.addType.$1", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -32615,13 +36856,23 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 37 - } + "lineNumber": 36 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.pureTransitions.extendContext", + "type": "Function", + "tags": [], + "label": "extendContext", + "description": [], "signature": [ "(state: ", { @@ -32649,52 +36900,91 @@ }, ">; }" ], - "description": [], - "label": "extendContext", "source": { "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 37 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.pureTransitions.extendContext.$1", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 37 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } ], - "description": [], - "label": "pureTransitions", - "source": { - "path": "src/plugins/expressions/common/executor/container.ts", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.range", "type": "Object", "tags": [], + "label": "range", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.range.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"range\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 22 }, - "signature": [ - "\"range\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.range.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.range.from.null", "type": "Function", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => ", { @@ -32705,53 +36995,36 @@ "text": "Range" } ], - "description": [], - "label": "null", "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/range.ts", - "lineNumber": 23 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.range.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.range.to.render", "type": "Function", - "children": [ - { - "id": "def-common.range.to.render.$1", - "type": "Object", - "label": "value", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Range", - "text": "Range" - } - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/range.ts", - "lineNumber": 33 - } - } - ], + "tags": [], + "label": "render", + "description": [], "signature": [ "(value: ", { @@ -32771,75 +37044,92 @@ }, "<\"render\", { as: string; value: { text: string; }; }>" ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "lineNumber": 33 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.range.to.render.$1", + "type": "Object", + "tags": [], + "label": "value", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Range", + "text": "Range" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 33 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/range.ts", - "lineNumber": 32 - } + ] } ], - "description": [], - "label": "range", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/range.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.render", "type": "Object", "tags": [], + "label": "render", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.render.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"render\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "lineNumber": 32 }, - "signature": [ - "\"render\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.render.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.render.from.", "type": "Function", - "children": [ - { - "id": "def-common.render.from..$1", - "type": "Uncategorized", - "label": "v", - "isRequired": true, - "signature": [ - "T" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/render.ts", - "lineNumber": 34 - } - } - ], + "tags": [], + "label": "'*'", + "description": [], "signature": [ "(v: T) => ", { @@ -32851,82 +37141,86 @@ }, "<\"render\", { as: string; value: T; }>" ], - "description": [], - "label": "'*'", "source": { "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "lineNumber": 34 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.render.from..$1", + "type": "Uncategorized", + "tags": [], + "label": "v", + "description": [], + "signature": [ + "T" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 34 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/render.ts", - "lineNumber": 33 - } + ] } ], - "description": [], - "label": "render", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/render.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.shape", "type": "Object", "tags": [], + "label": "shape", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.shape.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"shape\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", "lineNumber": 15 }, - "signature": [ - "\"shape\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.shape.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.shape.to.render", "type": "Function", - "children": [ - { - "id": "def-common.shape.to.render.$1", - "type": "CompoundType", - "label": "input", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"render\", { as: string; value: any; }>" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", - "lineNumber": 17 - } - } - ], + "tags": [], + "label": "render", + "description": [], "signature": [ "(input: ", { @@ -32946,166 +37240,198 @@ }, "<\"render\", { as: string; value: any; }>; }" ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", "lineNumber": 17 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.shape.to.render.$1", + "type": "CompoundType", + "tags": [], + "label": "input", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: any; }>" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 17 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", - "lineNumber": 16 - } + ] } ], - "description": [], - "label": "shape", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.string", "type": "Object", "tags": [], + "label": "string", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.string.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"string\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "lineNumber": 16 }, - "signature": [ - "\"string\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.string.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.string.from.null", "type": "Function", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "null", "source": { "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "lineNumber": 18 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.string.from.boolean", "type": "Function", + "tags": [], + "label": "boolean", + "description": [], + "signature": [ + "(b: any) => string" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.string.from.boolean.$1", "type": "Any", + "tags": [], "label": "b", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(b: any) => string" - ], - "description": [], - "label": "boolean", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/string.ts", - "lineNumber": 19 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.string.from.number", "type": "Function", + "tags": [], + "label": "number", + "description": [], + "signature": [ + "(n: any) => string" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.string.from.number.$1", "type": "Any", + "tags": [], "label": "n", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(n: any) => string" - ], - "description": [], - "label": "number", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/string.ts", - "lineNumber": 20 - }, - "tags": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/string.ts", - "lineNumber": 17 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.string.to", "type": "Object", "tags": [], + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.string.to.render", "type": "Function", - "children": [ - { - "id": "def-common.string.to.render.$1", - "type": "Uncategorized", - "label": "text", - "isRequired": true, - "signature": [ - "T" - ], - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/string.ts", - "lineNumber": 23 - } - } - ], + "tags": [], + "label": "render", + "description": [], "signature": [ "(text: T) => ", { @@ -33117,34 +37443,39 @@ }, "<\"render\", { as: string; value: { text: T; }; }>" ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "lineNumber": 23 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.string.to.datatable", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.string.to.datatable.$1", - "type": "string", - "label": "value", - "isRequired": true, + "parentPluginId": "expressions", + "id": "def-common.string.to.render.$1", + "type": "Uncategorized", + "tags": [], + "label": "text", + "description": [], "signature": [ - "string" + "T" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/string.ts", - "lineNumber": 30 - } + "lineNumber": 23 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.string.to.datatable", + "type": "Function", + "tags": [], + "label": "datatable", + "description": [], "signature": [ "(value: string) => ", { @@ -33155,287 +37486,370 @@ "text": "Datatable" } ], - "description": [], - "label": "datatable", "source": { "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "lineNumber": 30 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.string.to.datatable.$1", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 30 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } - ], - "description": [], - "label": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/string.ts", - "lineNumber": 22 - } + ] } ], - "description": [], - "label": "string", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/string.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.style", "type": "Object", "tags": [], + "label": "style", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/style.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.style.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"style\"" + ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/style.ts", "lineNumber": 15 }, - "signature": [ - "\"style\"" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.style.from", "type": "Object", "tags": [], + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/style.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.style.from.null", "type": "Function", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => { type: \"style\"; spec: {}; css: string; }" ], - "description": [], - "label": "null", "source": { "path": "src/plugins/expressions/common/expression_types/specs/style.ts", "lineNumber": 17 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } - ], - "description": [], - "label": "from", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/style.ts", - "lineNumber": 16 - } + ] } ], - "description": [], - "label": "style", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/style.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.theme", "type": "Object", "tags": [], + "label": "theme", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.theme.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"theme\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 28 }, - "signature": [ - "\"theme\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.theme.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "never[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 29 }, - "signature": [ - "never[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.theme.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.theme.inputTypes", "type": "Array", + "tags": [], "label": "inputTypes", "description": [], + "signature": [ + "\"null\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 33 }, - "signature": [ - "\"null\"[]" - ] + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.theme.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.theme.args.variable", "type": "Object", "tags": [], + "label": "variable", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.theme.args.variable.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 36 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.theme.args.variable.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 37 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.theme.args.variable.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 40 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.theme.args.variable.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 41 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false } - ], - "description": [], - "label": "variable", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", - "lineNumber": 35 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.theme.args.default", "type": "Object", "tags": [], + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.theme.args.default.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 44 - } + }, + "deprecated": false } - ], - "description": [], - "label": "default", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", - "lineNumber": 43 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", - "lineNumber": 34 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.theme.fn", "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(input: null, args: Arguments, handlers: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">) => any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.theme.fn.$1", "type": "Uncategorized", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "null" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.theme.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.theme.fn.$3", "type": "Object", + "tags": [], "label": "handlers", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -33456,165 +37870,159 @@ "SerializableState", ">" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(input: null, args: Arguments, handlers: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">) => any" - ], - "description": [], - "label": "fn", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", - "lineNumber": 49 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "theme", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.variable", "type": "Object", "tags": [], + "label": "variable", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variable.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"var\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 24 }, - "signature": [ - "\"var\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variable.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.variable.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.variable.args.name", "type": "Object", "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variable.args.name.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 30 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variable.args.name.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 31 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variable.args.name.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 32 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variable.args.name.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 33 - } + }, + "deprecated": false } - ], - "description": [], - "label": "name", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", - "lineNumber": 29 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", - "lineNumber": 28 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.variable.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: unknown, args: Arguments, context: ", { @@ -33636,41 +38044,53 @@ "SerializableState", ">) => any" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.variable.fn.$1", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.variable.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.variable.fn.$3", "type": "Object", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -33691,180 +38111,203 @@ "SerializableState", ">" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", - "lineNumber": 38 - } + "returnComment": [] } ], - "description": [], - "label": "variable", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.variableSet", "type": "Object", "tags": [], + "label": "variableSet", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variableSet.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "\"var_set\"" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 25 }, - "signature": [ - "\"var_set\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variableSet.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 26 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.variableSet.args", "type": "Object", "tags": [], + "label": "args", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.variableSet.args.name", "type": "Object", "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.types", "type": "Array", + "tags": [], "label": "types", "description": [], + "signature": [ + "\"string\"[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 31 }, - "signature": [ - "\"string\"[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 32 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.required", "type": "boolean", + "tags": [], "label": "required", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 33 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 34 - } + }, + "deprecated": false } - ], - "description": [], - "label": "name", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", - "lineNumber": 30 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.variableSet.args.value", "type": "Object", "tags": [], + "label": "value", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variableSet.args.value.aliases", "type": "Array", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 39 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.variableSet.args.value.help", "type": "string", + "tags": [], "label": "help", "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 40 - } + }, + "deprecated": false } - ], - "description": [], - "label": "value", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", - "lineNumber": 38 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", - "lineNumber": 29 - } + ] }, { + "parentPluginId": "expressions", "id": "def-common.variableSet.fn", "type": "Function", + "tags": [], "label": "fn", + "description": [], "signature": [ "(input: unknown, args: Arguments, context: ", { @@ -33886,41 +38329,53 @@ "SerializableState", ">) => unknown" ], - "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.variableSet.fn.$1", "type": "Unknown", + "tags": [], "label": "input", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.variableSet.fn.$2", "type": "Object", + "tags": [], "label": "args", - "isRequired": true, + "description": [], "signature": [ "Arguments" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.variableSet.fn.$3", "type": "Object", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -33941,27 +38396,17 @@ "SerializableState", ">" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", - "lineNumber": 46 - } + "returnComment": [] } ], - "description": [], - "label": "variableSet", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", - "lineNumber": 24 - }, "initialIsOpen": false } ] diff --git a/api_docs/features.json b/api_docs/features.json index 3755e99beb3b0..7ee7224882213 100644 --- a/api_docs/features.json +++ b/api_docs/features.json @@ -3,22 +3,25 @@ "client": { "classes": [ { + "parentPluginId": "features", "id": "def-public.KibanaFeature", "type": "Class", "tags": [], "label": "KibanaFeature", "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 137 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeature.subFeatures", "type": "Array", + "tags": [], "label": "subFeatures", "description": [], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 138 - }, "signature": [ { "pluginId": "features", @@ -28,22 +31,36 @@ "text": "SubFeature" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 138 + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 140 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-public.KibanaFeature.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", { @@ -55,183 +72,206 @@ }, "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], - "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 140 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 140 - } + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.id", "type": "string", - "label": "id", "tags": [], + "label": "id", "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 146 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.name", "type": "string", - "label": "name", "tags": [], + "label": "name", "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 150 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.order", "type": "number", - "label": "order", "tags": [], + "label": "order", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 154 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.category", "type": "Object", - "label": "category", "tags": [], + "label": "category", "description": [], + "signature": [ + "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 158 }, - "signature": [ - "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.app", "type": "Object", - "label": "app", "tags": [], + "label": "app", "description": [], + "signature": [ + "readonly string[]" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 162 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.catalogue", "type": "Object", - "label": "catalogue", "tags": [], + "label": "catalogue", "description": [], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 166 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.management", "type": "Object", - "label": "management", "tags": [], + "label": "management", "description": [], + "signature": [ + "Readonly<{ [x: string]: readonly string[]; }> | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 170 }, - "signature": [ - "Readonly<{ [x: string]: readonly string[]; }> | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.minimumLicense", "type": "CompoundType", - "label": "minimumLicense", "tags": [], + "label": "minimumLicense", "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 174 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.privileges", "type": "CompoundType", - "label": "privileges", "tags": [], + "label": "privileges", "description": [], + "signature": [ + "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 178 }, - "signature": [ - "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.alerting", "type": "Object", - "label": "alerting", "tags": [], + "label": "alerting", "description": [], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 182 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.excludeFromBasePrivileges", "type": "boolean", - "label": "excludeFromBasePrivileges", "tags": [], + "label": "excludeFromBasePrivileges", "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 186 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.reserved", "type": "Object", - "label": "reserved", "tags": [], + "label": "reserved", "description": [], + "signature": [ + "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 190 }, - "signature": [ - "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeature.toRaw", "type": "Function", + "tags": [], "label": "toRaw", + "description": [], "signature": [ "() => ", { @@ -242,186 +282,206 @@ "text": "KibanaFeatureConfig" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 194 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 137 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "features", "id": "def-public.FeatureKibanaPrivileges", "type": "Interface", + "tags": [], "label": "FeatureKibanaPrivileges", "description": [ "\nFeature privilege definition" ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-public.FeatureKibanaPrivileges.excludeFromBasePrivileges", "type": "CompoundType", + "tags": [], "label": "excludeFromBasePrivileges", "description": [ "\nWhether or not this specific privilege should be excluded from the base privileges." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 15 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.FeatureKibanaPrivileges.management", "type": "Object", + "tags": [], "label": "management", "description": [ "\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on user privileges.\n" ], + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 29 }, - "signature": [ - "{ [sectionId: string]: readonly string[]; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.FeatureKibanaPrivileges.catalogue", "type": "Object", + "tags": [], "label": "catalogue", "description": [ "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 36 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.FeatureKibanaPrivileges.api", "type": "Object", + "tags": [], "label": "api", "description": [ "\nIf your feature includes server-side APIs, you can tag those routes to secure access based on user permissions.\n" ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 64 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.FeatureKibanaPrivileges.app", "type": "Object", + "tags": [], "label": "app", "description": [ "\nIf your feature exposes a client-side application (most of them do!), then you can control access to them here.\n" ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 77 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.FeatureKibanaPrivileges.alerting", "type": "Object", + "tags": [], "label": "alerting", "description": [ "\nIf your feature requires access to specific Alert Types, then specify your access needs here.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access." ], + "signature": [ + "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 84 }, - "signature": [ - "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.FeatureKibanaPrivileges.savedObject", "type": "Object", + "tags": [], "label": "savedObject", "description": [ "\nIf your feature requires access to specific saved objects, then specify your access needs here." ], + "signature": [ + "{ all: readonly string[]; read: readonly string[]; }" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 110 }, - "signature": [ - "{ all: readonly string[]; read: readonly string[]; }" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-public.FeatureKibanaPrivileges.ui", + "type": "Object", "tags": [ "see" ], - "id": "def-public.FeatureKibanaPrivileges.ui", - "type": "Object", "label": "ui", "description": [ "\nA list of UI Capabilities that should be granted to users with this privilege.\nThese capabilities will automatically be namespaces within your feature id.\n" ], + "signature": [ + "readonly string[]" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 153 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig", "type": "Interface", + "tags": [], "label": "KibanaFeatureConfig", "description": [ "\nInterface for registering a feature.\nFeature registration allows plugins to hide their applications with spaces,\nand secure access when configured for security." ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", + "id": "def-public.KibanaFeatureConfig.id", + "type": "string", "tags": [ "see" ], - "id": "def-public.KibanaFeatureConfig.id", - "type": "string", "label": "id", "description": [ "\nUnique identifier for this feature.\nThis identifier is also used when generating UI Capabilities.\n" @@ -429,12 +489,14 @@ "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 27 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nDisplay name for this feature.\nThis will be displayed to end-users, so a translatable string is advised for i18n." @@ -442,150 +504,164 @@ "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.category", "type": "Object", + "tags": [], "label": "category", "description": [ "\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens." ], + "signature": [ + "AppCategory" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 40 }, - "signature": [ - "AppCategory" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.order", "type": "number", + "tags": [], "label": "order", "description": [ "\nAn ordinal used to sort features relative to one another for display." ], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 45 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.excludeFromBasePrivileges", "type": "CompoundType", + "tags": [], "label": "excludeFromBasePrivileges", "description": [ "\nWhether or not this feature should be excluded from the base privileges.\nThis is primarily helpful when migrating applications with a \"legacy\" privileges model\nto use Kibana privileges. We don't want these features to be considered part of the `all`\nor `read` base privileges in a minor release if the user was previously granted access\nusing an additional reserved role." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 54 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.minimumLicense", "type": "CompoundType", + "tags": [], "label": "minimumLicense", "description": [ "\nOptional minimum supported license.\nIf omitted, all licenses are allowed.\nThis does not restrict access to your feature based on license.\nIts only purpose is to inform the space and roles UIs on which features to display." ], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 62 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.app", "type": "Object", + "tags": [], "label": "app", "description": [ "\nAn array of app ids that are enabled when this feature is enabled.\nApps specified here will automatically cascade to the privileges defined below, unless specified differently there." ], + "signature": [ + "readonly string[]" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 68 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.management", "type": "Object", + "tags": [], "label": "management", "description": [ "\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there.\n" ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 84 - }, "signature": [ "{ [sectionId: string]: readonly string[]; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 84 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.catalogue", "type": "Object", + "tags": [], "label": "catalogue", "description": [ "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 92 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.alerting", "type": "Object", + "tags": [], "label": "alerting", "description": [ "\nIf your feature grants access to specific Alert Types, you can specify them here to control visibility based on the current space.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 99 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-public.KibanaFeatureConfig.privileges", + "type": "CompoundType", "tags": [ "see" ], - "id": "def-public.KibanaFeatureConfig.privileges", - "type": "CompoundType", "label": "privileges", "description": [ "\nFeature privilege definition.\n" ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 113 - }, "signature": [ "{ all: ", { @@ -604,20 +680,22 @@ "text": "FeatureKibanaPrivileges" }, "; } | null" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.subFeatures", "type": "Object", + "tags": [], "label": "subFeatures", "description": [ "\nOptional sub-feature privilege definitions. This can only be specified if `privileges` are are also defined." ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 121 - }, "signature": [ "readonly ", { @@ -628,62 +706,74 @@ "text": "SubFeatureConfig" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 121 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.privilegesTooltip", "type": "string", + "tags": [], "label": "privilegesTooltip", "description": [ "\nOptional message to display on the Role Management screen when configuring permissions for this feature." ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 126 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-public.KibanaFeatureConfig.reserved", + "type": "Object", "tags": [ "private" ], - "id": "def-public.KibanaFeatureConfig.reserved", - "type": "Object", "label": "reserved", "description": [], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 131 - }, "signature": [ "{ description: string; privileges: readonly ", "ReservedKibanaPrivilege", "[]; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 131 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-public.SubFeatureConfig", "type": "Interface", + "tags": [], "label": "SubFeatureConfig", "description": [ "\nConfiguration for a sub-feature." ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-public.SubFeatureConfig.name", "type": "string", + "tags": [], "label": "name", "description": [ "Display name for this sub-feature" @@ -691,20 +781,18 @@ "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.SubFeatureConfig.privilegeGroups", "type": "Object", + "tags": [], "label": "privilegeGroups", "description": [ "Collection of privilege groups" ], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 20 - }, "signature": [ "readonly ", { @@ -715,19 +803,25 @@ "text": "SubFeaturePrivilegeGroupConfig" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 20 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-public.SubFeaturePrivilegeConfig", "type": "Interface", + "tags": [], "label": "SubFeaturePrivilegeConfig", + "description": [ + "\nConfiguration for a sub-feature privilege." + ], "signature": [ { "pluginId": "features", @@ -746,15 +840,17 @@ }, ", \"management\" | \"catalogue\" | \"alerting\" | \"ui\" | \"app\" | \"api\" | \"savedObject\">" ], - "description": [ - "\nConfiguration for a sub-feature privilege." - ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-public.SubFeaturePrivilegeConfig.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nIdentifier for this privilege. Must be unique across all other privileges within a feature." @@ -762,12 +858,14 @@ "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 61 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.SubFeaturePrivilegeConfig.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nThe display name for this privilege." @@ -775,45 +873,46 @@ "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 66 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.SubFeaturePrivilegeConfig.includeIn", "type": "CompoundType", + "tags": [], "label": "includeIn", "description": [ "\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically." ], + "signature": [ + "\"read\" | \"all\" | \"none\"" + ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 72 }, - "signature": [ - "\"read\" | \"all\" | \"none\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-public.SubFeaturePrivilegeConfig.minimumLicense", "type": "CompoundType", + "tags": [], "label": "minimumLicense", "description": [ "\nThe minimum supported license level for this sub-feature privilege.\nIf no license level is supplied, then this privilege will be available for all licences\nthat are valid for the overall feature." ], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 79 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 56 - }, "initialIsOpen": false } ], @@ -821,31 +920,30 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "features", "id": "def-public.FeaturesPluginSetup", "type": "Type", - "label": "FeaturesPluginSetup", "tags": [], + "label": "FeaturesPluginSetup", "description": [], + "signature": [ + "void" + ], "source": { "path": "x-pack/plugins/features/public/plugin.ts", "lineNumber": 27 }, - "signature": [ - "void" - ], + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "features", "id": "def-public.FeaturesPluginStart", "type": "Type", - "label": "FeaturesPluginStart", "tags": [], + "label": "FeaturesPluginStart", "description": [], - "source": { - "path": "x-pack/plugins/features/public/plugin.ts", - "lineNumber": 28 - }, "signature": [ "{ getFeatures: () => Promise<", { @@ -857,6 +955,11 @@ }, "[]>; }" ], + "source": { + "path": "x-pack/plugins/features/public/plugin.ts", + "lineNumber": 28 + }, + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -864,26 +967,41 @@ "server": { "classes": [ { + "parentPluginId": "features", "id": "def-server.ElasticsearchFeature", "type": "Class", "tags": [], "label": "ElasticsearchFeature", "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-server.ElasticsearchFeature.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-server.ElasticsearchFeature.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Readonly<{ id: string; management?: Readonly<{ [x: string]: ", "RecursiveReadonlyArray", @@ -901,72 +1019,71 @@ }, ">; }>" ], - "description": [], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 65 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 65 - } + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-server.ElasticsearchFeature.id", "type": "string", - "label": "id", "tags": [], + "label": "id", "description": [], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 67 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.ElasticsearchFeature.catalogue", "type": "Object", - "label": "catalogue", "tags": [], + "label": "catalogue", "description": [], + "signature": [ + "RecursiveReadonlyArray", + " | undefined" + ], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 71 }, - "signature": [ - "RecursiveReadonlyArray", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.ElasticsearchFeature.management", "type": "Object", - "label": "management", "tags": [], + "label": "management", "description": [], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 75 - }, "signature": [ "Readonly<{ [x: string]: ", "RecursiveReadonlyArray", "; }> | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 75 + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.ElasticsearchFeature.privileges", "type": "Object", - "label": "privileges", "tags": [], + "label": "privileges", "description": [], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 79 - }, "signature": [ "RecursiveReadonlyArray", "<", @@ -978,12 +1095,20 @@ "text": "FeatureElasticsearchPrivileges" }, ">" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 79 + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.ElasticsearchFeature.toRaw", "type": "Function", + "tags": [], "label": "toRaw", + "description": [], "signature": [ "() => ", { @@ -994,39 +1119,37 @@ "text": "ElasticsearchFeatureConfig" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 64 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature", "type": "Class", "tags": [], "label": "KibanaFeature", "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 137 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeature.subFeatures", "type": "Array", + "tags": [], "label": "subFeatures", "description": [], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 138 - }, "signature": [ { "pluginId": "features", @@ -1036,22 +1159,36 @@ "text": "SubFeature" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 138 + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 140 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-server.KibanaFeature.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", { @@ -1063,183 +1200,206 @@ }, "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], - "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 140 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 140 - } + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.id", "type": "string", - "label": "id", "tags": [], + "label": "id", "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 146 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.name", "type": "string", - "label": "name", "tags": [], + "label": "name", "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 150 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.order", "type": "number", - "label": "order", "tags": [], + "label": "order", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 154 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.category", "type": "Object", - "label": "category", "tags": [], + "label": "category", "description": [], + "signature": [ + "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 158 }, - "signature": [ - "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.app", "type": "Object", - "label": "app", "tags": [], + "label": "app", "description": [], + "signature": [ + "readonly string[]" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 162 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.catalogue", "type": "Object", - "label": "catalogue", "tags": [], + "label": "catalogue", "description": [], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 166 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.management", "type": "Object", - "label": "management", "tags": [], + "label": "management", "description": [], + "signature": [ + "Readonly<{ [x: string]: readonly string[]; }> | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 170 }, - "signature": [ - "Readonly<{ [x: string]: readonly string[]; }> | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.minimumLicense", "type": "CompoundType", - "label": "minimumLicense", "tags": [], + "label": "minimumLicense", "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 174 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.privileges", "type": "CompoundType", - "label": "privileges", "tags": [], + "label": "privileges", "description": [], + "signature": [ + "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 178 }, - "signature": [ - "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.alerting", "type": "Object", - "label": "alerting", "tags": [], + "label": "alerting", "description": [], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 182 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.excludeFromBasePrivileges", "type": "boolean", - "label": "excludeFromBasePrivileges", "tags": [], + "label": "excludeFromBasePrivileges", "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 186 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.reserved", "type": "Object", - "label": "reserved", "tags": [], + "label": "reserved", "description": [], + "signature": [ + "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 190 }, - "signature": [ - "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeature.toRaw", "type": "Function", + "tags": [], "label": "toRaw", + "description": [], "signature": [ "() => ", { @@ -1250,40 +1410,42 @@ "text": "KibanaFeatureConfig" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 194 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 137 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "features", "id": "def-server.ElasticsearchFeatureConfig", "type": "Interface", + "tags": [], "label": "ElasticsearchFeatureConfig", "description": [ "\nInterface for registering an Elasticsearch feature.\nFeature registration allows plugins to hide their applications based\non configured cluster or index privileges." ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", + "id": "def-server.ElasticsearchFeatureConfig.id", + "type": "string", "tags": [ "see" ], - "id": "def-server.ElasticsearchFeatureConfig.id", - "type": "string", "label": "id", "description": [ "\nUnique identifier for this feature.\nThis identifier is also used when generating UI Capabilities.\n" @@ -1291,54 +1453,56 @@ "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.ElasticsearchFeatureConfig.management", "type": "Object", + "tags": [], "label": "management", "description": [ "\nManagement sections associated with this feature.\n" ], + "signature": [ + "{ [sectionId: string]: string[]; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 36 }, - "signature": [ - "{ [sectionId: string]: string[]; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.ElasticsearchFeatureConfig.catalogue", "type": "Array", + "tags": [], "label": "catalogue", "description": [ "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 44 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-server.ElasticsearchFeatureConfig.privileges", + "type": "Array", "tags": [ "see" ], - "id": "def-server.ElasticsearchFeatureConfig.privileges", - "type": "Array", "label": "privileges", "description": [ "\nFeature privilege definition. Specify one or more privileges which grant access to this feature.\nUsers must satisfy all privileges in at least one of the defined sets of privileges in order to be granted access.\n" ], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 61 - }, "signature": [ { "pluginId": "features", @@ -1348,260 +1512,312 @@ "text": "FeatureElasticsearchPrivileges" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 61 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-server.FeatureElasticsearchPrivileges", "type": "Interface", + "tags": [], "label": "FeatureElasticsearchPrivileges", "description": [ "\nElasticsearch Feature privilege definition" ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-server.FeatureElasticsearchPrivileges.requiredClusterPrivileges", "type": "Array", + "tags": [], "label": "requiredClusterPrivileges", "description": [ "\nA set of Elasticsearch cluster privileges which are required for this feature to be enabled.\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html\n" ], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", "lineNumber": 17 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.FeatureElasticsearchPrivileges.requiredIndexPrivileges", "type": "Object", + "tags": [], "label": "requiredIndexPrivileges", "description": [ "\nA set of Elasticsearch index privileges which are required for this feature to be enabled, keyed on index name or pattern.\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html#privileges-list-indices\n" ], + "signature": [ + "{ [indexName: string]: string[]; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", "lineNumber": 38 }, - "signature": [ - "{ [indexName: string]: string[]; } | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-server.FeatureElasticsearchPrivileges.requiredRoles", + "type": "Array", "tags": [ "deprecated" ], - "id": "def-server.FeatureElasticsearchPrivileges.requiredRoles", - "type": "Array", "label": "requiredRoles", "description": [ "\nA set of Elasticsearch roles which are required for this feature to be enabled.\n" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", "lineNumber": 50 }, - "signature": [ - "string[] | undefined" + "deprecated": true, + "references": [ + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts", + "lineNumber": 311 + } + }, + { + "plugin": "beatsManagement", + "link": { + "path": "x-pack/plugins/beats_management/server/plugin.ts", + "lineNumber": 61 + } + } ] }, { + "parentPluginId": "features", + "id": "def-server.FeatureElasticsearchPrivileges.ui", + "type": "Array", "tags": [ "see" ], - "id": "def-server.FeatureElasticsearchPrivileges.ui", - "type": "Array", "label": "ui", "description": [ "\nA list of UI Capabilities that should be granted to users with this privilege.\nThese capabilities will automatically be namespaces within your feature id.\n" ], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", "lineNumber": 72 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-server.FeatureKibanaPrivileges", "type": "Interface", + "tags": [], "label": "FeatureKibanaPrivileges", "description": [ "\nFeature privilege definition" ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-server.FeatureKibanaPrivileges.excludeFromBasePrivileges", "type": "CompoundType", + "tags": [], "label": "excludeFromBasePrivileges", "description": [ "\nWhether or not this specific privilege should be excluded from the base privileges." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 15 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.FeatureKibanaPrivileges.management", "type": "Object", + "tags": [], "label": "management", "description": [ "\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on user privileges.\n" ], + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 29 }, - "signature": [ - "{ [sectionId: string]: readonly string[]; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.FeatureKibanaPrivileges.catalogue", "type": "Object", + "tags": [], "label": "catalogue", "description": [ "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 36 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.FeatureKibanaPrivileges.api", "type": "Object", + "tags": [], "label": "api", "description": [ "\nIf your feature includes server-side APIs, you can tag those routes to secure access based on user permissions.\n" ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 64 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.FeatureKibanaPrivileges.app", "type": "Object", + "tags": [], "label": "app", "description": [ "\nIf your feature exposes a client-side application (most of them do!), then you can control access to them here.\n" ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 77 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.FeatureKibanaPrivileges.alerting", "type": "Object", + "tags": [], "label": "alerting", "description": [ "\nIf your feature requires access to specific Alert Types, then specify your access needs here.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access." ], + "signature": [ + "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 84 }, - "signature": [ - "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.FeatureKibanaPrivileges.savedObject", "type": "Object", + "tags": [], "label": "savedObject", "description": [ "\nIf your feature requires access to specific saved objects, then specify your access needs here." ], + "signature": [ + "{ all: readonly string[]; read: readonly string[]; }" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 110 }, - "signature": [ - "{ all: readonly string[]; read: readonly string[]; }" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-server.FeatureKibanaPrivileges.ui", + "type": "Object", "tags": [ "see" ], - "id": "def-server.FeatureKibanaPrivileges.ui", - "type": "Object", "label": "ui", "description": [ "\nA list of UI Capabilities that should be granted to users with this privilege.\nThese capabilities will automatically be namespaces within your feature id.\n" ], + "signature": [ + "readonly string[]" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 153 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig", "type": "Interface", + "tags": [], "label": "KibanaFeatureConfig", "description": [ "\nInterface for registering a feature.\nFeature registration allows plugins to hide their applications with spaces,\nand secure access when configured for security." ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", + "id": "def-server.KibanaFeatureConfig.id", + "type": "string", "tags": [ "see" ], - "id": "def-server.KibanaFeatureConfig.id", - "type": "string", "label": "id", "description": [ "\nUnique identifier for this feature.\nThis identifier is also used when generating UI Capabilities.\n" @@ -1609,12 +1825,14 @@ "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 27 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nDisplay name for this feature.\nThis will be displayed to end-users, so a translatable string is advised for i18n." @@ -1622,150 +1840,164 @@ "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.category", "type": "Object", + "tags": [], "label": "category", "description": [ "\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens." ], + "signature": [ + "AppCategory" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 40 }, - "signature": [ - "AppCategory" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.order", "type": "number", + "tags": [], "label": "order", "description": [ "\nAn ordinal used to sort features relative to one another for display." ], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 45 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.excludeFromBasePrivileges", "type": "CompoundType", + "tags": [], "label": "excludeFromBasePrivileges", "description": [ "\nWhether or not this feature should be excluded from the base privileges.\nThis is primarily helpful when migrating applications with a \"legacy\" privileges model\nto use Kibana privileges. We don't want these features to be considered part of the `all`\nor `read` base privileges in a minor release if the user was previously granted access\nusing an additional reserved role." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 54 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.minimumLicense", "type": "CompoundType", + "tags": [], "label": "minimumLicense", "description": [ "\nOptional minimum supported license.\nIf omitted, all licenses are allowed.\nThis does not restrict access to your feature based on license.\nIts only purpose is to inform the space and roles UIs on which features to display." ], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 62 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.app", "type": "Object", + "tags": [], "label": "app", "description": [ "\nAn array of app ids that are enabled when this feature is enabled.\nApps specified here will automatically cascade to the privileges defined below, unless specified differently there." ], + "signature": [ + "readonly string[]" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 68 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.management", "type": "Object", + "tags": [], "label": "management", "description": [ "\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there.\n" ], + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 84 }, - "signature": [ - "{ [sectionId: string]: readonly string[]; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.catalogue", "type": "Object", + "tags": [], "label": "catalogue", "description": [ "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 92 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.alerting", "type": "Object", + "tags": [], "label": "alerting", "description": [ "\nIf your feature grants access to specific Alert Types, you can specify them here to control visibility based on the current space.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 99 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-server.KibanaFeatureConfig.privileges", + "type": "CompoundType", "tags": [ "see" ], - "id": "def-server.KibanaFeatureConfig.privileges", - "type": "CompoundType", "label": "privileges", "description": [ "\nFeature privilege definition.\n" ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 113 - }, "signature": [ "{ all: ", { @@ -1784,20 +2016,22 @@ "text": "FeatureKibanaPrivileges" }, "; } | null" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.subFeatures", "type": "Object", + "tags": [], "label": "subFeatures", "description": [ "\nOptional sub-feature privilege definitions. This can only be specified if `privileges` are are also defined." ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 121 - }, "signature": [ "readonly ", { @@ -1808,62 +2042,76 @@ "text": "SubFeatureConfig" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 121 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.privilegesTooltip", "type": "string", + "tags": [], "label": "privilegesTooltip", "description": [ "\nOptional message to display on the Role Management screen when configuring permissions for this feature." ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 126 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-server.KibanaFeatureConfig.reserved", + "type": "Object", "tags": [ "private" ], - "id": "def-server.KibanaFeatureConfig.reserved", - "type": "Object", "label": "reserved", "description": [], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 131 - }, "signature": [ "{ description: string; privileges: readonly ", "ReservedKibanaPrivilege", "[]; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 131 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-server.PluginSetupContract", "type": "Interface", + "tags": [], "label": "PluginSetupContract", "description": [ "\nDescribes public Features plugin contract returned at the `setup` stage." ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-server.PluginSetupContract.registerKibanaFeature", "type": "Function", + "tags": [], "label": "registerKibanaFeature", + "description": [], "signature": [ "(feature: ", { @@ -1875,13 +2123,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-server.PluginSetupContract.registerKibanaFeature.$1", "type": "Object", + "tags": [], "label": "feature", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "features", @@ -1891,24 +2145,23 @@ "text": "KibanaFeatureConfig" } ], - "description": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 34 - } + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-server.PluginSetupContract.registerElasticsearchFeature", "type": "Function", + "tags": [], "label": "registerElasticsearchFeature", + "description": [], "signature": [ "(feature: ", { @@ -1920,13 +2173,19 @@ }, ") => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-server.PluginSetupContract.registerElasticsearchFeature.$1", "type": "Object", + "tags": [], "label": "feature", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "features", @@ -1936,24 +2195,23 @@ "text": "ElasticsearchFeatureConfig" } ], - "description": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 35 - } + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-server.PluginSetupContract.getKibanaFeatures", "type": "Function", + "tags": [], "label": "getKibanaFeatures", + "description": [], "signature": [ "() => ", { @@ -1965,19 +2223,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-server.PluginSetupContract.getElasticsearchFeatures", "type": "Function", + "tags": [], "label": "getElasticsearchFeatures", + "description": [], "signature": [ "() => ", { @@ -1989,50 +2249,74 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-server.PluginSetupContract.getFeaturesUICapabilities", "type": "Function", + "tags": [], "label": "getFeaturesUICapabilities", + "description": [], "signature": [ "() => ", "Capabilities" ], - "description": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [], + "returnComment": [] + }, + { + "parentPluginId": "features", + "id": "def-server.PluginSetupContract.enableReportingUiCapabilities", + "type": "Function", "tags": [], - "returnComment": [], + "label": "enableReportingUiCapabilities", + "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 48 - } + "lineNumber": 56 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 33 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-server.PluginStartContract", "type": "Interface", + "tags": [], "label": "PluginStartContract", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-server.PluginStartContract.getElasticsearchFeatures", "type": "Function", + "tags": [], "label": "getElasticsearchFeatures", + "description": [], "signature": [ "() => ", { @@ -2044,19 +2328,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 52 - } + "lineNumber": 60 + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-server.PluginStartContract.getKibanaFeatures", "type": "Function", + "tags": [], "label": "getKibanaFeatures", + "description": [], "signature": [ "() => ", { @@ -2068,20 +2354,15 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 53 - } + "lineNumber": 61 + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 51 - }, "initialIsOpen": false } ], @@ -2089,18 +2370,20 @@ "misc": [], "objects": [ { - "tags": [], + "parentPluginId": "features", "id": "def-server.uiCapabilitiesRegex", "type": "Object", + "tags": [], "label": "uiCapabilitiesRegex", "description": [], + "signature": [ + "RegExp" + ], "source": { "path": "x-pack/plugins/features/server/feature_schema.ts", "lineNumber": 23 }, - "signature": [ - "RegExp" - ], + "deprecated": false, "initialIsOpen": false } ] @@ -2108,26 +2391,41 @@ "common": { "classes": [ { + "parentPluginId": "features", "id": "def-common.ElasticsearchFeature", "type": "Class", "tags": [], "label": "ElasticsearchFeature", "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-common.ElasticsearchFeature.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-common.ElasticsearchFeature.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Readonly<{ id: string; management?: Readonly<{ [x: string]: ", "RecursiveReadonlyArray", @@ -2145,72 +2443,71 @@ }, ">; }>" ], - "description": [], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 65 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 65 - } + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-common.ElasticsearchFeature.id", "type": "string", - "label": "id", "tags": [], + "label": "id", "description": [], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 67 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.ElasticsearchFeature.catalogue", "type": "Object", - "label": "catalogue", "tags": [], + "label": "catalogue", "description": [], + "signature": [ + "RecursiveReadonlyArray", + " | undefined" + ], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 71 }, - "signature": [ - "RecursiveReadonlyArray", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.ElasticsearchFeature.management", "type": "Object", - "label": "management", "tags": [], + "label": "management", "description": [], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 75 - }, "signature": [ "Readonly<{ [x: string]: ", "RecursiveReadonlyArray", "; }> | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 75 + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.ElasticsearchFeature.privileges", "type": "Object", - "label": "privileges", "tags": [], + "label": "privileges", "description": [], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 79 - }, "signature": [ "RecursiveReadonlyArray", "<", @@ -2222,12 +2519,20 @@ "text": "FeatureElasticsearchPrivileges" }, ">" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 79 + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.ElasticsearchFeature.toRaw", "type": "Function", + "tags": [], "label": "toRaw", + "description": [], "signature": [ "() => ", { @@ -2238,39 +2543,37 @@ "text": "ElasticsearchFeatureConfig" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 64 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature", "type": "Class", "tags": [], "label": "KibanaFeature", "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 137 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeature.subFeatures", "type": "Array", + "tags": [], "label": "subFeatures", "description": [], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 138 - }, "signature": [ { "pluginId": "features", @@ -2280,22 +2583,36 @@ "text": "SubFeature" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 138 + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 140 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-common.KibanaFeature.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", { @@ -2307,183 +2624,206 @@ }, "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], - "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 140 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 140 - } + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.id", "type": "string", - "label": "id", "tags": [], + "label": "id", "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 146 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.name", "type": "string", - "label": "name", "tags": [], + "label": "name", "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 150 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.order", "type": "number", - "label": "order", "tags": [], + "label": "order", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 154 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.category", "type": "Object", - "label": "category", "tags": [], + "label": "category", "description": [], + "signature": [ + "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 158 }, - "signature": [ - "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.app", "type": "Object", - "label": "app", "tags": [], + "label": "app", "description": [], + "signature": [ + "readonly string[]" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 162 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.catalogue", "type": "Object", - "label": "catalogue", "tags": [], + "label": "catalogue", "description": [], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 166 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.management", "type": "Object", - "label": "management", "tags": [], + "label": "management", "description": [], + "signature": [ + "Readonly<{ [x: string]: readonly string[]; }> | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 170 }, - "signature": [ - "Readonly<{ [x: string]: readonly string[]; }> | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.minimumLicense", "type": "CompoundType", - "label": "minimumLicense", "tags": [], + "label": "minimumLicense", "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 174 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.privileges", "type": "CompoundType", - "label": "privileges", "tags": [], + "label": "privileges", "description": [], + "signature": [ + "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 178 }, - "signature": [ - "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.alerting", "type": "Object", - "label": "alerting", "tags": [], + "label": "alerting", "description": [], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 182 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.excludeFromBasePrivileges", "type": "boolean", - "label": "excludeFromBasePrivileges", "tags": [], + "label": "excludeFromBasePrivileges", "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 186 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.reserved", "type": "Object", - "label": "reserved", "tags": [], + "label": "reserved", "description": [], + "signature": [ + "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 190 }, - "signature": [ - "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeature.toRaw", "type": "Function", + "tags": [], "label": "toRaw", + "description": [], "signature": [ "() => ", { @@ -2494,43 +2834,53 @@ "text": "KibanaFeatureConfig" } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 194 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 137 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-common.SubFeature", "type": "Class", "tags": [], "label": "SubFeature", "description": [], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 82 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-common.SubFeature.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", "id": "def-common.SubFeature.Unnamed.$1", "type": "Object", + "tags": [], "label": "config", - "isRequired": true, + "description": [], "signature": [ "Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", { @@ -2542,41 +2892,36 @@ }, "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>" ], - "description": [], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 83 - } + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-common.SubFeature.name", "type": "string", - "label": "name", "tags": [], + "label": "name", "description": [], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 85 - } + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.SubFeature.privilegeGroups", "type": "Object", - "label": "privilegeGroups", "tags": [], + "label": "privilegeGroups", "description": [], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 89 - }, "signature": [ "readonly Readonly<{ groupType: ", { @@ -2587,12 +2932,20 @@ "text": "SubFeaturePrivilegeGroupType" }, "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 89 + }, + "deprecated": false }, { + "parentPluginId": "features", "id": "def-common.SubFeature.toRaw", "type": "Function", + "tags": [], "label": "toRaw", + "description": [], "signature": [ "() => { name: string; privilegeGroups: readonly Readonly<{ groupType: ", { @@ -2604,40 +2957,42 @@ }, "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 93 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 82 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "features", "id": "def-common.ElasticsearchFeatureConfig", "type": "Interface", + "tags": [], "label": "ElasticsearchFeatureConfig", "description": [ "\nInterface for registering an Elasticsearch feature.\nFeature registration allows plugins to hide their applications based\non configured cluster or index privileges." ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", + "id": "def-common.ElasticsearchFeatureConfig.id", + "type": "string", "tags": [ "see" ], - "id": "def-common.ElasticsearchFeatureConfig.id", - "type": "string", "label": "id", "description": [ "\nUnique identifier for this feature.\nThis identifier is also used when generating UI Capabilities.\n" @@ -2645,54 +3000,56 @@ "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.ElasticsearchFeatureConfig.management", "type": "Object", + "tags": [], "label": "management", "description": [ "\nManagement sections associated with this feature.\n" ], + "signature": [ + "{ [sectionId: string]: string[]; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 36 }, - "signature": [ - "{ [sectionId: string]: string[]; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.ElasticsearchFeatureConfig.catalogue", "type": "Array", + "tags": [], "label": "catalogue", "description": [ "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "lineNumber": 44 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-common.ElasticsearchFeatureConfig.privileges", + "type": "Array", "tags": [ "see" ], - "id": "def-common.ElasticsearchFeatureConfig.privileges", - "type": "Array", "label": "privileges", "description": [ "\nFeature privilege definition. Specify one or more privileges which grant access to this feature.\nUsers must satisfy all privileges in at least one of the defined sets of privileges in order to be granted access.\n" ], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 61 - }, "signature": [ { "pluginId": "features", @@ -2702,260 +3059,312 @@ "text": "FeatureElasticsearchPrivileges" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 61 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-common.FeatureElasticsearchPrivileges", "type": "Interface", + "tags": [], "label": "FeatureElasticsearchPrivileges", "description": [ "\nElasticsearch Feature privilege definition" ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-common.FeatureElasticsearchPrivileges.requiredClusterPrivileges", "type": "Array", + "tags": [], "label": "requiredClusterPrivileges", "description": [ "\nA set of Elasticsearch cluster privileges which are required for this feature to be enabled.\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html\n" ], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", "lineNumber": 17 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.FeatureElasticsearchPrivileges.requiredIndexPrivileges", "type": "Object", + "tags": [], "label": "requiredIndexPrivileges", "description": [ "\nA set of Elasticsearch index privileges which are required for this feature to be enabled, keyed on index name or pattern.\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html#privileges-list-indices\n" ], + "signature": [ + "{ [indexName: string]: string[]; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", "lineNumber": 38 }, - "signature": [ - "{ [indexName: string]: string[]; } | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-common.FeatureElasticsearchPrivileges.requiredRoles", + "type": "Array", "tags": [ "deprecated" ], - "id": "def-common.FeatureElasticsearchPrivileges.requiredRoles", - "type": "Array", "label": "requiredRoles", "description": [ "\nA set of Elasticsearch roles which are required for this feature to be enabled.\n" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", "lineNumber": 50 }, - "signature": [ - "string[] | undefined" + "deprecated": true, + "references": [ + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts", + "lineNumber": 311 + } + }, + { + "plugin": "beatsManagement", + "link": { + "path": "x-pack/plugins/beats_management/server/plugin.ts", + "lineNumber": 61 + } + } ] }, { + "parentPluginId": "features", + "id": "def-common.FeatureElasticsearchPrivileges.ui", + "type": "Array", "tags": [ "see" ], - "id": "def-common.FeatureElasticsearchPrivileges.ui", - "type": "Array", "label": "ui", "description": [ "\nA list of UI Capabilities that should be granted to users with this privilege.\nThese capabilities will automatically be namespaces within your feature id.\n" ], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", "lineNumber": 72 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-common.FeatureKibanaPrivileges", "type": "Interface", + "tags": [], "label": "FeatureKibanaPrivileges", "description": [ "\nFeature privilege definition" ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-common.FeatureKibanaPrivileges.excludeFromBasePrivileges", "type": "CompoundType", + "tags": [], "label": "excludeFromBasePrivileges", "description": [ "\nWhether or not this specific privilege should be excluded from the base privileges." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 15 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.FeatureKibanaPrivileges.management", "type": "Object", + "tags": [], "label": "management", "description": [ "\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on user privileges.\n" ], + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 29 }, - "signature": [ - "{ [sectionId: string]: readonly string[]; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.FeatureKibanaPrivileges.catalogue", "type": "Object", + "tags": [], "label": "catalogue", "description": [ "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 36 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.FeatureKibanaPrivileges.api", "type": "Object", + "tags": [], "label": "api", "description": [ "\nIf your feature includes server-side APIs, you can tag those routes to secure access based on user permissions.\n" ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 64 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.FeatureKibanaPrivileges.app", "type": "Object", + "tags": [], "label": "app", "description": [ "\nIf your feature exposes a client-side application (most of them do!), then you can control access to them here.\n" ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 77 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.FeatureKibanaPrivileges.alerting", "type": "Object", + "tags": [], "label": "alerting", "description": [ "\nIf your feature requires access to specific Alert Types, then specify your access needs here.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access." ], + "signature": [ + "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 84 }, - "signature": [ - "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.FeatureKibanaPrivileges.savedObject", "type": "Object", + "tags": [], "label": "savedObject", "description": [ "\nIf your feature requires access to specific saved objects, then specify your access needs here." ], + "signature": [ + "{ all: readonly string[]; read: readonly string[]; }" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 110 }, - "signature": [ - "{ all: readonly string[]; read: readonly string[]; }" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-common.FeatureKibanaPrivileges.ui", + "type": "Object", "tags": [ "see" ], - "id": "def-common.FeatureKibanaPrivileges.ui", - "type": "Object", "label": "ui", "description": [ "\nA list of UI Capabilities that should be granted to users with this privilege.\nThese capabilities will automatically be namespaces within your feature id.\n" ], + "signature": [ + "readonly string[]" + ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "lineNumber": 153 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig", "type": "Interface", + "tags": [], "label": "KibanaFeatureConfig", "description": [ "\nInterface for registering a feature.\nFeature registration allows plugins to hide their applications with spaces,\nand secure access when configured for security." ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "features", + "id": "def-common.KibanaFeatureConfig.id", + "type": "string", "tags": [ "see" ], - "id": "def-common.KibanaFeatureConfig.id", - "type": "string", "label": "id", "description": [ "\nUnique identifier for this feature.\nThis identifier is also used when generating UI Capabilities.\n" @@ -2963,12 +3372,14 @@ "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 27 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nDisplay name for this feature.\nThis will be displayed to end-users, so a translatable string is advised for i18n." @@ -2976,150 +3387,164 @@ "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.category", "type": "Object", + "tags": [], "label": "category", "description": [ "\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens." ], + "signature": [ + "AppCategory" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 40 }, - "signature": [ - "AppCategory" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.order", "type": "number", + "tags": [], "label": "order", "description": [ "\nAn ordinal used to sort features relative to one another for display." ], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 45 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.excludeFromBasePrivileges", "type": "CompoundType", + "tags": [], "label": "excludeFromBasePrivileges", "description": [ "\nWhether or not this feature should be excluded from the base privileges.\nThis is primarily helpful when migrating applications with a \"legacy\" privileges model\nto use Kibana privileges. We don't want these features to be considered part of the `all`\nor `read` base privileges in a minor release if the user was previously granted access\nusing an additional reserved role." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 54 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.minimumLicense", "type": "CompoundType", + "tags": [], "label": "minimumLicense", "description": [ "\nOptional minimum supported license.\nIf omitted, all licenses are allowed.\nThis does not restrict access to your feature based on license.\nIts only purpose is to inform the space and roles UIs on which features to display." ], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 62 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.app", "type": "Object", + "tags": [], "label": "app", "description": [ "\nAn array of app ids that are enabled when this feature is enabled.\nApps specified here will automatically cascade to the privileges defined below, unless specified differently there." ], + "signature": [ + "readonly string[]" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 68 }, - "signature": [ - "readonly string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.management", "type": "Object", + "tags": [], "label": "management", "description": [ "\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there.\n" ], + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 84 }, - "signature": [ - "{ [sectionId: string]: readonly string[]; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.catalogue", "type": "Object", + "tags": [], "label": "catalogue", "description": [ "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 92 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.alerting", "type": "Object", + "tags": [], "label": "alerting", "description": [ "\nIf your feature grants access to specific Alert Types, you can specify them here to control visibility based on the current space.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access." ], + "signature": [ + "readonly string[] | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 99 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-common.KibanaFeatureConfig.privileges", + "type": "CompoundType", "tags": [ "see" ], - "id": "def-common.KibanaFeatureConfig.privileges", - "type": "CompoundType", "label": "privileges", "description": [ "\nFeature privilege definition.\n" ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 113 - }, "signature": [ "{ all: ", { @@ -3138,20 +3563,22 @@ "text": "FeatureKibanaPrivileges" }, "; } | null" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.subFeatures", "type": "Object", + "tags": [], "label": "subFeatures", "description": [ "\nOptional sub-feature privilege definitions. This can only be specified if `privileges` are are also defined." ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 121 - }, "signature": [ "readonly ", { @@ -3162,62 +3589,74 @@ "text": "SubFeatureConfig" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 121 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.privilegesTooltip", "type": "string", + "tags": [], "label": "privilegesTooltip", "description": [ "\nOptional message to display on the Role Management screen when configuring permissions for this feature." ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", "lineNumber": 126 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "features", + "id": "def-common.KibanaFeatureConfig.reserved", + "type": "Object", "tags": [ "private" ], - "id": "def-common.KibanaFeatureConfig.reserved", - "type": "Object", "label": "reserved", "description": [], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 131 - }, "signature": [ "{ description: string; privileges: readonly ", "ReservedKibanaPrivilege", "[]; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 131 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-common.SubFeatureConfig", "type": "Interface", + "tags": [], "label": "SubFeatureConfig", "description": [ "\nConfiguration for a sub-feature." ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-common.SubFeatureConfig.name", "type": "string", + "tags": [], "label": "name", "description": [ "Display name for this sub-feature" @@ -3225,20 +3664,18 @@ "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.SubFeatureConfig.privilegeGroups", "type": "Object", + "tags": [], "label": "privilegeGroups", "description": [ "Collection of privilege groups" ], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 20 - }, "signature": [ "readonly ", { @@ -3249,19 +3686,25 @@ "text": "SubFeaturePrivilegeGroupConfig" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 20 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-common.SubFeaturePrivilegeConfig", "type": "Interface", + "tags": [], "label": "SubFeaturePrivilegeConfig", + "description": [ + "\nConfiguration for a sub-feature privilege." + ], "signature": [ { "pluginId": "features", @@ -3280,15 +3723,17 @@ }, ", \"management\" | \"catalogue\" | \"alerting\" | \"ui\" | \"app\" | \"api\" | \"savedObject\">" ], - "description": [ - "\nConfiguration for a sub-feature privilege." - ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-common.SubFeaturePrivilegeConfig.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nIdentifier for this privilege. Must be unique across all other privileges within a feature." @@ -3296,12 +3741,14 @@ "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 61 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.SubFeaturePrivilegeConfig.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nThe display name for this privilege." @@ -3309,68 +3756,72 @@ "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 66 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.SubFeaturePrivilegeConfig.includeIn", "type": "CompoundType", + "tags": [], "label": "includeIn", "description": [ "\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically." ], + "signature": [ + "\"read\" | \"all\" | \"none\"" + ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 72 }, - "signature": [ - "\"read\" | \"all\" | \"none\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.SubFeaturePrivilegeConfig.minimumLicense", "type": "CompoundType", + "tags": [], "label": "minimumLicense", "description": [ "\nThe minimum supported license level for this sub-feature privilege.\nIf no license level is supplied, then this privilege will be available for all licences\nthat are valid for the overall feature." ], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 79 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 56 - }, "initialIsOpen": false }, { + "parentPluginId": "features", "id": "def-common.SubFeaturePrivilegeGroupConfig", "type": "Interface", + "tags": [], "label": "SubFeaturePrivilegeGroupConfig", "description": [ "\nConfiguration for a sub-feature privilege group." ], - "tags": [], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "features", "id": "def-common.SubFeaturePrivilegeGroupConfig.groupType", "type": "CompoundType", + "tags": [], "label": "groupType", "description": [ "\nThe type of privilege group.\n- `mutually_exclusive`::\n Users will be able to select at most one privilege within this group.\n Privileges must be specified in descending order of permissiveness (e.g. `All`, `Read`, not `Read`, `All)\n- `independent`::\n Users will be able to select any combination of privileges within this group." ], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 45 - }, "signature": [ { "pluginId": "features", @@ -3379,20 +3830,22 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" } - ] + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 45 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "features", "id": "def-common.SubFeaturePrivilegeGroupConfig.privileges", "type": "Object", + "tags": [], "label": "privileges", "description": [ "\nThe privileges which belong to this group." ], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 50 - }, "signature": [ "readonly ", { @@ -3403,33 +3856,36 @@ "text": "SubFeaturePrivilegeConfig" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 50 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/features/common/sub_feature.ts", - "lineNumber": 36 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "features", "id": "def-common.SubFeaturePrivilegeGroupType", "type": "Type", - "label": "SubFeaturePrivilegeGroupType", "tags": [], + "label": "SubFeaturePrivilegeGroupType", "description": [ "\nThe type of privilege group.\n- `mutually_exclusive`::\n Users will be able to select at most one privilege within this group.\n Privileges must be specified in descending order of permissiveness (e.g. `All`, `Read`, not `Read`, `All)\n- `independent`::\n Users will be able to select any combination of privileges within this group." ], + "signature": [ + "\"mutually_exclusive\" | \"independent\"" + ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", "lineNumber": 31 }, - "signature": [ - "\"mutually_exclusive\" | \"independent\"" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/file_data_visualizer.json b/api_docs/file_data_visualizer.json new file mode 100644 index 0000000000000..f149805e261de --- /dev/null +++ b/api_docs/file_data_visualizer.json @@ -0,0 +1,328 @@ +{ + "id": "fileDataVisualizer", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "start": { + "parentPluginId": "fileDataVisualizer", + "id": "def-public.FileDataVisualizerPluginStart", + "type": "Type", + "tags": [], + "label": "FileDataVisualizerPluginStart", + "description": [], + "signature": [ + "{ getFileDataVisualizerComponent: typeof getFileDataVisualizerComponent; getMaxBytesFormatted: typeof getMaxBytesFormatted; }" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/public/plugin.ts", + "lineNumber": 33 + }, + "deprecated": false, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.DataVisualizerTableState", + "type": "Interface", + "tags": [], + "label": "DataVisualizerTableState", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 14 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.DataVisualizerTableState.pageSize", + "type": "number", + "tags": [], + "label": "pageSize", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 15 + }, + "deprecated": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.DataVisualizerTableState.pageIndex", + "type": "number", + "tags": [], + "label": "pageIndex", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 16 + }, + "deprecated": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.DataVisualizerTableState.sortField", + "type": "string", + "tags": [], + "label": "sortField", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 17 + }, + "deprecated": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.DataVisualizerTableState.sortDirection", + "type": "string", + "tags": [], + "label": "sortDirection", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 18 + }, + "deprecated": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.DataVisualizerTableState.visibleFieldTypes", + "type": "Array", + "tags": [], + "label": "visibleFieldTypes", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 19 + }, + "deprecated": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.DataVisualizerTableState.visibleFieldNames", + "type": "Array", + "tags": [], + "label": "visibleFieldNames", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 20 + }, + "deprecated": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.DataVisualizerTableState.showDistributions", + "type": "boolean", + "tags": [], + "label": "showDistributions", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 21 + }, + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.ABSOLUTE_MAX_FILE_SIZE_BYTES", + "type": "number", + "tags": [], + "label": "ABSOLUTE_MAX_FILE_SIZE_BYTES", + "description": [], + "signature": [ + "1073741274" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 14 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.FILE_SIZE_DISPLAY_FORMAT", + "type": "string", + "tags": [], + "label": "FILE_SIZE_DISPLAY_FORMAT", + "description": [], + "signature": [ + "\"0,0.[0] b\"" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 15 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.INDEX_META_DATA_CREATED_BY", + "type": "string", + "tags": [], + "label": "INDEX_META_DATA_CREATED_BY", + "description": [], + "signature": [ + "\"file-data-visualizer\"" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 19 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.InputData", + "type": "Type", + "tags": [], + "label": "InputData", + "description": [], + "signature": [ + "any[]" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 10 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.JobFieldType", + "type": "Type", + "tags": [], + "label": "JobFieldType", + "description": [], + "signature": [ + "\"number\" | \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"unknown\" | \"geo_point\" | \"geo_shape\"" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 12 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.MAX_FILE_SIZE", + "type": "string", + "tags": [], + "label": "MAX_FILE_SIZE", + "description": [], + "signature": [ + "\"100MB\"" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 11 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.MAX_FILE_SIZE_BYTES", + "type": "number", + "tags": [], + "label": "MAX_FILE_SIZE_BYTES", + "description": [], + "signature": [ + "104857600" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 12 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.MB", + "type": "number", + "tags": [], + "label": "MB", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 10 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.UI_SETTING_MAX_FILE_SIZE", + "type": "string", + "tags": [], + "label": "UI_SETTING_MAX_FILE_SIZE", + "description": [], + "signature": [ + "\"fileUpload:maxFileSize\"" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 8 + }, + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "fileDataVisualizer", + "id": "def-common.JOB_FIELD_TYPES", + "type": "Object", + "tags": [], + "label": "JOB_FIELD_TYPES", + "description": [], + "signature": [ + "{ readonly BOOLEAN: \"boolean\"; readonly DATE: \"date\"; readonly GEO_POINT: \"geo_point\"; readonly GEO_SHAPE: \"geo_shape\"; readonly IP: \"ip\"; readonly KEYWORD: \"keyword\"; readonly NUMBER: \"number\"; readonly TEXT: \"text\"; readonly UNKNOWN: \"unknown\"; }" + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 21 + }, + "deprecated": false, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/file_data_visualizer.mdx b/api_docs/file_data_visualizer.mdx new file mode 100644 index 0000000000000..07d4fc76d448a --- /dev/null +++ b/api_docs/file_data_visualizer.mdx @@ -0,0 +1,29 @@ +--- +id: kibFileDataVisualizerPluginApi +slug: /kibana-dev-docs/fileDataVisualizerPluginApi +title: fileDataVisualizer +image: https://source.unsplash.com/400x175/?github +summary: API docs for the fileDataVisualizer plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileDataVisualizer'] +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 fileDataVisualizerObj from './file_data_visualizer.json'; + +## Client + +### Start + + +## Common + +### Objects + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/file_upload.json b/api_docs/file_upload.json index 09b3b11040a69..80d3add483ffc 100644 --- a/api_docs/file_upload.json +++ b/api_docs/file_upload.json @@ -5,99 +5,51 @@ "functions": [], "interfaces": [ { - "id": "def-public.AnalysisResult", - "type": "Interface", - "label": "AnalysisResult", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.AnalysisResult.results", - "type": "Object", - "label": "results", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 26 - }, - "signature": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.FindFileStructureResponse", - "text": "FindFileStructureResponse" - } - ] - }, - { - "tags": [], - "id": "def-public.AnalysisResult.overrides", - "type": "CompoundType", - "label": "overrides", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 27 - }, - "signature": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.FormattedOverrides", - "text": "FormattedOverrides" - }, - " | undefined" - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 25 - }, - "initialIsOpen": false - }, - { + "parentPluginId": "fileUpload", "id": "def-public.CreateDocsResponse", "type": "Interface", + "tags": [], "label": "CreateDocsResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.CreateDocsResponse.success", "type": "boolean", + "tags": [], "label": "success", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.CreateDocsResponse.remainder", "type": "number", + "tags": [], "label": "remainder", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.CreateDocsResponse.docs", "type": "Array", + "tags": [], "label": "docs", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 33 - }, "signature": [ { "pluginId": "fileUpload", @@ -107,272 +59,212 @@ "text": "ImportDoc" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.CreateDocsResponse.error", "type": "Any", + "tags": [], "label": "error", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 34 }, - "signature": [ - "any" - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 30 - }, - "initialIsOpen": false - }, - { - "id": "def-public.Doc", - "type": "Interface", - "label": "Doc", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.Doc.message", - "type": "string", - "label": "message", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 100 - } + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 99 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-public.FileUploadComponentProps", "type": "Interface", + "tags": [], "label": "FileUploadComponentProps", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadComponentProps.isIndexingTriggered", "type": "boolean", + "tags": [], "label": "isIndexingTriggered", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 16 - } + "lineNumber": 24 + }, + "deprecated": false }, { - "tags": [], - "id": "def-public.FileUploadComponentProps.onFileUpload", + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadComponentProps.onFileSelect", "type": "Function", - "label": "onFileUpload", + "tags": [], + "label": "onFileSelect", "description": [], + "signature": [ + "(geojsonFile: GeoJSON.FeatureCollection, name: string, previewCoverage: number) => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 17 + "lineNumber": 25 }, - "signature": [ - "(geojsonFile: GeoJSON.FeatureCollection, name: string, previewCoverage: number) => void" - ] + "deprecated": false }, { - "tags": [], - "id": "def-public.FileUploadComponentProps.onFileRemove", + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadComponentProps.onFileClear", "type": "Function", - "label": "onFileRemove", + "tags": [], + "label": "onFileClear", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 18 + "lineNumber": 26 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], - "id": "def-public.FileUploadComponentProps.onIndexReady", + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadComponentProps.enableImportBtn", "type": "Function", - "label": "onIndexReady", + "tags": [], + "label": "enableImportBtn", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 19 + "lineNumber": 27 }, - "signature": [ - "(indexReady: boolean) => void" - ] + "deprecated": false }, { - "tags": [], - "id": "def-public.FileUploadComponentProps.onIndexingComplete", + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadComponentProps.disableImportBtn", "type": "Function", - "label": "onIndexingComplete", + "tags": [], + "label": "disableImportBtn", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 20 + "lineNumber": 28 }, + "deprecated": false + }, + { + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadComponentProps.onUploadComplete", + "type": "Function", + "tags": [], + "label": "onUploadComplete", + "description": [], "signature": [ - "(results: { indexDataResp: ", + "(results: ", { "pluginId": "fileUpload", "scope": "public", "docId": "kibFileUploadPluginApi", - "section": "def-public.ImportResults", - "text": "ImportResults" - }, - "; indexPattern: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-public.FileUploadGeoResults", + "text": "FileUploadGeoResults" }, - "; }) => void" - ] + ") => void" + ], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], - "id": "def-public.FileUploadComponentProps.onIndexingError", + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadComponentProps.onUploadError", "type": "Function", - "label": "onIndexingError", + "tags": [], + "label": "onUploadError", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 24 + "lineNumber": 30 }, - "signature": [ - "() => void" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { - "id": "def-public.FindFileStructureResponse", + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadGeoResults", "type": "Interface", - "label": "FindFileStructureResponse", - "description": [], "tags": [], + "label": "FileUploadGeoResults", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-public.FindFileStructureResponse.charset", - "type": "string", - "label": "charset", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 31 - } - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.has_header_row", - "type": "boolean", - "label": "has_header_row", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 32 - } - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.has_byte_order_marker", - "type": "boolean", - "label": "has_byte_order_marker", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 33 - } - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.format", + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadGeoResults.indexPatternId", "type": "string", - "label": "format", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 34 - } - }, - { "tags": [], - "id": "def-public.FindFileStructureResponse.field_stats", - "type": "Object", - "label": "field_stats", + "label": "indexPatternId", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 35 + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 17 }, - "signature": [ - "{ [fieldName: string]: { count: number; cardinality: number; top_hits: { count: number; value: any; }[]; mean_value?: number | undefined; median_value?: number | undefined; max_value?: number | undefined; min_value?: number | undefined; earliest?: string | undefined; latest?: string | undefined; }; }" - ] + "deprecated": false }, { - "tags": [], - "id": "def-public.FindFileStructureResponse.sample_start", + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadGeoResults.geoFieldName", "type": "string", - "label": "sample_start", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 48 - } - }, - { "tags": [], - "id": "def-public.FindFileStructureResponse.num_messages_analyzed", - "type": "number", - "label": "num_messages_analyzed", + "label": "geoFieldName", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 49 - } + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 18 + }, + "deprecated": false }, { + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadGeoResults.geoFieldType", + "type": "CompoundType", "tags": [], - "id": "def-public.FindFileStructureResponse.mappings", - "type": "Object", - "label": "mappings", + "label": "geoFieldType", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 50 - }, "signature": [ - "{ properties: { [fieldName: string]: { type: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" - }, - ".STRING | ", { "pluginId": "data", "scope": "common", @@ -380,7 +272,7 @@ "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" }, - ".TEXT | ", + ".GEO_POINT | ", { "pluginId": "data", "scope": "common", @@ -388,268 +280,86 @@ "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" }, - ".KEYWORD | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" - }, - ".BOOLEAN | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" - } - ] - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.quote", - "type": "string", - "label": "quote", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 63 - } - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.delimiter", - "type": "string", - "label": "delimiter", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 64 - } - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.need_client_timezone", - "type": "boolean", - "label": "need_client_timezone", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 65 - } - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.num_lines_analyzed", - "type": "number", - "label": "num_lines_analyzed", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 66 - } - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.column_names", - "type": "Array", - "label": "column_names", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 67 - }, - "signature": [ - "string[] | undefined" - ] - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.explanation", - "type": "Array", - "label": "explanation", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 68 - }, - "signature": [ - "string[] | undefined" - ] - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.grok_pattern", - "type": "string", - "label": "grok_pattern", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 69 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.multiline_start_pattern", - "type": "string", - "label": "multiline_start_pattern", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 70 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.exclude_lines_pattern", - "type": "string", - "label": "exclude_lines_pattern", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 71 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.java_timestamp_formats", - "type": "Array", - "label": "java_timestamp_formats", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 72 - }, - "signature": [ - "string[] | undefined" - ] - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.joda_timestamp_formats", - "type": "Array", - "label": "joda_timestamp_formats", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 73 - }, - "signature": [ - "string[] | undefined" - ] - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.timestamp_field", - "type": "string", - "label": "timestamp_field", - "description": [], + ".GEO_SHAPE" + ], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 74 + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "fileUpload", + "id": "def-public.FileUploadGeoResults.docCount", + "type": "number", "tags": [], - "id": "def-public.FindFileStructureResponse.should_trim_fields", - "type": "CompoundType", - "label": "should_trim_fields", + "label": "docCount", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 75 + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 20 }, - "signature": [ - "boolean | undefined" - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 30 - }, - "initialIsOpen": false - }, - { - "id": "def-public.HasImportPermission", - "type": "Interface", - "label": "HasImportPermission", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.HasImportPermission.hasImportPermission", - "type": "boolean", - "label": "hasImportPermission", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 12 - } + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-public.IImporter", "type": "Interface", + "tags": [], "label": "IImporter", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.read", "type": "Function", + "tags": [], "label": "read", + "description": [], "signature": [ "(data: ArrayBuffer) => { success: boolean; }" ], - "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.read.$1", "type": "Object", + "tags": [], "label": "data", - "isRequired": true, + "description": [], "signature": [ "ArrayBuffer" ], - "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 44 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 44 - } + "returnComment": [] }, { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.initializeImport", "type": "Function", + "tags": [], "label": "initializeImport", + "description": [], "signature": [ "(index: string, settings: ", { @@ -685,27 +395,36 @@ }, ">" ], - "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.initializeImport.$1", "type": "string", + "tags": [], "label": "index", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.initializeImport.$2", "type": "Object", + "tags": [], "label": "settings", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "fileUpload", @@ -715,17 +434,20 @@ "text": "Settings" } ], - "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.initializeImport.$3", "type": "Object", + "tags": [], "label": "mappings", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "fileUpload", @@ -735,17 +457,20 @@ "text": "Mappings" } ], - "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 48 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.initializeImport.$4", "type": "Object", + "tags": [], "label": "pipeline", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "fileUpload", @@ -755,24 +480,23 @@ "text": "IngestPipeline" } ], - "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 45 - } + "returnComment": [] }, { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.import", "type": "Function", + "tags": [], "label": "import", + "description": [], "signature": [ "(id: string, index: string, pipelineId: string | undefined, setImportProgress: (progress: number) => void) => Promise<", { @@ -784,96 +508,106 @@ }, ">" ], - "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.import.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 52 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.import.$2", "type": "string", + "tags": [], "label": "index", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.import.$3", "type": "string", + "tags": [], "label": "pipelineId", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "fileUpload", "id": "def-public.IImporter.import.$4", "type": "Function", + "tags": [], "label": "setImportProgress", - "isRequired": true, + "description": [], "signature": [ "(progress: number) => void" ], - "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 51 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 43 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-public.ImportConfig", "type": "Interface", + "tags": [], "label": "ImportConfig", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.ImportConfig.settings", "type": "Object", + "tags": [], "label": "settings", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 18 - }, "signature": [ { "pluginId": "fileUpload", @@ -882,18 +616,20 @@ "section": "def-common.Settings", "text": "Settings" } - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 18 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.ImportConfig.mappings", "type": "Object", + "tags": [], "label": "mappings", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "fileUpload", @@ -902,18 +638,20 @@ "section": "def-common.Mappings", "text": "Mappings" } - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.ImportConfig.pipeline", "type": "Object", + "tags": [], "label": "pipeline", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 20 - }, "signature": [ { "pluginId": "fileUpload", @@ -922,60 +660,68 @@ "section": "def-common.IngestPipeline", "text": "IngestPipeline" } - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 20 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-public.ImportFactoryOptions", "type": "Interface", + "tags": [], "label": "ImportFactoryOptions", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.ImportFactoryOptions.excludeLinesPattern", "type": "string", + "tags": [], "label": "excludeLinesPattern", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 38 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.ImportFactoryOptions.multilineStartPattern", "type": "string", + "tags": [], "label": "multilineStartPattern", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 39 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.ImportFactoryOptions.importConfig", "type": "Object", + "tags": [], "label": "importConfig", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 40 - }, "signature": [ { "pluginId": "fileUpload", @@ -984,225 +730,49 @@ "section": "def-public.ImportConfig", "text": "ImportConfig" } - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 37 - }, - "initialIsOpen": false - }, - { - "id": "def-public.ImportFailure", - "type": "Interface", - "label": "ImportFailure", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.ImportFailure.item", - "type": "number", - "label": "item", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 94 - } - }, - { - "tags": [], - "id": "def-public.ImportFailure.reason", - "type": "string", - "label": "reason", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 95 - } - }, - { - "tags": [], - "id": "def-public.ImportFailure.doc", - "type": "CompoundType", - "label": "doc", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 96 - }, - "signature": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.ImportDoc", - "text": "ImportDoc" - } - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 93 - }, - "initialIsOpen": false - }, - { - "id": "def-public.ImportResponse", - "type": "Interface", - "label": "ImportResponse", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.ImportResponse.success", - "type": "boolean", - "label": "success", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 81 - } - }, - { - "tags": [], - "id": "def-public.ImportResponse.id", - "type": "string", - "label": "id", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 82 - } - }, - { - "tags": [], - "id": "def-public.ImportResponse.index", - "type": "string", - "label": "index", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 83 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.ImportResponse.pipelineId", - "type": "string", - "label": "pipelineId", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 84 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.ImportResponse.docCount", - "type": "number", - "label": "docCount", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 85 - } - }, - { - "tags": [], - "id": "def-public.ImportResponse.failures", - "type": "Array", - "label": "failures", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 86 - }, - "signature": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.ImportFailure", - "text": "ImportFailure" - }, - "[]" - ] - }, - { - "tags": [], - "id": "def-public.ImportResponse.error", - "type": "Object", - "label": "error", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 87 - }, - "signature": [ - "{ error: ", - "ErrorCause", - "; } | undefined" - ] - }, - { - "tags": [], - "id": "def-public.ImportResponse.ingestError", - "type": "CompoundType", - "label": "ingestError", - "description": [], + ], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 90 + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 40 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 80 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-public.ImportResults", "type": "Interface", + "tags": [], "label": "ImportResults", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.ImportResults.success", "type": "boolean", + "tags": [], "label": "success", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.ImportResults.failures", "type": "Array", + "tags": [], "label": "failures", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 25 - }, "signature": [ { "pluginId": "fileUpload", @@ -1212,436 +782,160 @@ "text": "ImportFailure" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 25 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.ImportResults.docCount", "type": "number", + "tags": [], "label": "docCount", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 26 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.ImportResults.error", "type": "Any", + "tags": [], "label": "error", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", "lineNumber": 27 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { - "id": "def-public.IngestPipeline", + "parentPluginId": "fileUpload", + "id": "def-public.Props", "type": "Interface", - "label": "IngestPipeline", - "description": [], "tags": [], + "label": "Props", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-public.IngestPipeline.description", + "parentPluginId": "fileUpload", + "id": "def-public.Props.indexName", "type": "string", - "label": "description", + "tags": [], + "label": "indexName", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 127 - } + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 15 + }, + "deprecated": false }, { + "parentPluginId": "fileUpload", + "id": "def-public.Props.indexNameError", + "type": "string", "tags": [], - "id": "def-public.IngestPipeline.processors", - "type": "Array", - "label": "processors", + "label": "indexNameError", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 128 - }, "signature": [ - "any[]" - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 126 - }, - "initialIsOpen": false - }, - { - "id": "def-public.IngestPipelineWrapper", - "type": "Interface", - "label": "IngestPipelineWrapper", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.IngestPipelineWrapper.id", - "type": "string", - "label": "id", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 122 - } - }, - { - "tags": [], - "id": "def-public.IngestPipelineWrapper.pipeline", - "type": "Object", - "label": "pipeline", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 123 - }, - "signature": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.IngestPipeline", - "text": "IngestPipeline" - } - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 121 - }, - "initialIsOpen": false - }, - { - "id": "def-public.InputOverrides", - "type": "Interface", - "label": "InputOverrides", - "description": [], - "tags": [], - "children": [ - { - "id": "def-public.InputOverrides.Unnamed", - "type": "Any", - "label": "Unnamed", - "tags": [], - "description": [], + "string | undefined" + ], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 16 }, - "signature": [ - "any" - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 15 - }, - "initialIsOpen": false - }, - { - "id": "def-public.Mappings", - "type": "Interface", - "label": "Mappings", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.Mappings._meta", - "type": "Object", - "label": "_meta", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 113 - }, - "signature": [ - "{ created_by: string; } | undefined" - ] + "deprecated": false }, { + "parentPluginId": "fileUpload", + "id": "def-public.Props.onIndexNameChange", + "type": "Function", "tags": [], - "id": "def-public.Mappings.properties", - "type": "Object", - "label": "properties", + "label": "onIndexNameChange", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 116 - }, "signature": [ - "{ [key: string]: any; }" - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 112 - }, - "initialIsOpen": false - }, - { - "id": "def-public.Settings", - "type": "Interface", - "label": "Settings", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.Settings.pipeline", - "type": "string", - "label": "pipeline", - "description": [], + "(name: string, error?: string | undefined) => void" + ], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 106 + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 17 }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.Settings.index", - "type": "string", - "label": "index", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 107 - } + "deprecated": false }, { + "parentPluginId": "fileUpload", + "id": "def-public.Props.onIndexNameValidationStart", + "type": "Function", "tags": [], - "id": "def-public.Settings.body", - "type": "Array", - "label": "body", + "label": "onIndexNameValidationStart", "description": [], + "signature": [ + "() => void" + ], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 108 + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 18 }, - "signature": [ - "any[]" - ] + "deprecated": false }, { - "id": "def-public.Settings.Unnamed", - "type": "Any", - "label": "Unnamed", + "parentPluginId": "fileUpload", + "id": "def-public.Props.onIndexNameValidationEnd", + "type": "Function", "tags": [], + "label": "onIndexNameValidationEnd", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 109 - }, "signature": [ - "any" - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 105 - }, - "initialIsOpen": false - } - ], - "enums": [], - "misc": [ - { - "tags": [], - "id": "def-public.ABSOLUTE_MAX_FILE_SIZE_BYTES", - "type": "number", - "label": "ABSOLUTE_MAX_FILE_SIZE_BYTES", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 14 - }, - "signature": [ - "1073741274" - ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-public.FILE_SIZE_DISPLAY_FORMAT", - "type": "string", - "label": "FILE_SIZE_DISPLAY_FORMAT", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 15 - }, - "signature": [ - "\"0,0.[0] b\"" - ], - "initialIsOpen": false - }, - { - "id": "def-public.FormattedOverrides", - "type": "Type", - "label": "FormattedOverrides", - "tags": [], - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 19 - }, - "signature": [ - "InputOverrides & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }" - ], - "initialIsOpen": false - }, - { - "id": "def-public.ImportDoc", - "type": "Type", - "label": "ImportDoc", - "tags": [], - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 103 - }, - "signature": [ - "string | object | ", - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.Doc", - "text": "Doc" - } - ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-public.INDEX_META_DATA_CREATED_BY", - "type": "string", - "label": "INDEX_META_DATA_CREATED_BY", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 19 - }, - "signature": [ - "\"ml-file-data-visualizer\"" - ], - "initialIsOpen": false - }, - { - "id": "def-public.InputData", - "type": "Type", - "label": "InputData", - "tags": [], - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 78 - }, - "signature": [ - "any[]" - ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-public.MAX_FILE_SIZE", - "type": "string", - "label": "MAX_FILE_SIZE", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 11 - }, - "signature": [ - "\"100MB\"" - ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-public.MAX_FILE_SIZE_BYTES", - "type": "number", - "label": "MAX_FILE_SIZE_BYTES", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 12 - }, - "signature": [ - "104857600" - ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-public.MB", - "type": "number", - "label": "MB", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 10 - }, - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-public.UI_SETTING_MAX_FILE_SIZE", - "type": "string", - "label": "UI_SETTING_MAX_FILE_SIZE", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 8 - }, - "signature": [ - "\"fileUpload:maxFileSize\"" + "() => void" + ], + "source": { + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 19 + }, + "deprecated": false + } ], "initialIsOpen": false } ], + "enums": [], + "misc": [], "objects": [], "start": { + "parentPluginId": "fileUpload", "id": "def-public.FileUploadPluginStart", "type": "Type", - "label": "FileUploadPluginStart", "tags": [], + "label": "FileUploadPluginStart", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/plugin.ts", - "lineNumber": 26 - }, "signature": [ "FileUploadStartApi" ], + "source": { + "path": "x-pack/plugins/file_upload/public/plugin.ts", + "lineNumber": 30 + }, + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -1659,22 +953,25 @@ "functions": [], "interfaces": [ { + "parentPluginId": "fileUpload", "id": "def-common.AnalysisResult", "type": "Interface", + "tags": [], "label": "AnalysisResult", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.AnalysisResult.results", "type": "Object", + "tags": [], "label": "results", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 26 - }, "signature": [ { "pluginId": "fileUpload", @@ -1683,18 +980,20 @@ "section": "def-common.FindFileStructureResponse", "text": "FindFileStructureResponse" } - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 22 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.AnalysisResult.overrides", "type": "CompoundType", + "tags": [], "label": "overrides", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 27 - }, "signature": [ { "pluginId": "fileUpload", @@ -1704,137 +1003,204 @@ "text": "FormattedOverrides" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 23 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.Doc", "type": "Interface", + "tags": [], "label": "Doc", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 117 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.Doc.message", "type": "string", + "tags": [], "label": "message", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 100 - } + "lineNumber": 118 + }, + "deprecated": false } ], + "initialIsOpen": false + }, + { + "parentPluginId": "fileUpload", + "id": "def-common.FindFileStructureErrorResponse", + "type": "Interface", + "tags": [], + "label": "FindFileStructureErrorResponse", + "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 99 + "lineNumber": 74 }, + "deprecated": false, + "children": [ + { + "parentPluginId": "fileUpload", + "id": "def-common.FindFileStructureErrorResponse.body", + "type": "Object", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "{ statusCode: number; error: string; message: string; attributes?: ErrorAttribute | undefined; }" + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 75 + }, + "deprecated": false + }, + { + "parentPluginId": "fileUpload", + "id": "def-common.FindFileStructureErrorResponse.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 81 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse", "type": "Interface", + "tags": [], "label": "FindFileStructureResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.charset", "type": "string", + "tags": [], "label": "charset", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 31 - } + "lineNumber": 27 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.has_header_row", "type": "boolean", + "tags": [], "label": "has_header_row", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 32 - } + "lineNumber": 28 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.has_byte_order_marker", "type": "boolean", + "tags": [], "label": "has_byte_order_marker", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 33 - } + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.format", "type": "string", + "tags": [], "label": "format", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 34 - } + "lineNumber": 30 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.field_stats", "type": "Object", + "tags": [], "label": "field_stats", "description": [], + "signature": [ + "{ [fieldName: string]: { count: number; cardinality: number; top_hits: { count: number; value: any; }[]; mean_value?: number | undefined; median_value?: number | undefined; max_value?: number | undefined; min_value?: number | undefined; earliest?: string | undefined; latest?: string | undefined; }; }" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 35 + "lineNumber": 31 }, - "signature": [ - "{ [fieldName: string]: { count: number; cardinality: number; top_hits: { count: number; value: any; }[]; mean_value?: number | undefined; median_value?: number | undefined; max_value?: number | undefined; min_value?: number | undefined; earliest?: string | undefined; latest?: string | undefined; }; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.sample_start", "type": "string", + "tags": [], "label": "sample_start", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 48 - } + "lineNumber": 44 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.num_messages_analyzed", "type": "number", + "tags": [], "label": "num_messages_analyzed", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 49 - } + "lineNumber": 45 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.mappings", "type": "Object", + "tags": [], "label": "mappings", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 50 - }, "signature": [ "{ properties: { [fieldName: string]: { type: ", { @@ -1876,249 +1242,287 @@ "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" } - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 46 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.quote", "type": "string", + "tags": [], "label": "quote", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 63 - } + "lineNumber": 59 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.delimiter", "type": "string", + "tags": [], "label": "delimiter", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 64 - } + "lineNumber": 60 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.need_client_timezone", "type": "boolean", + "tags": [], "label": "need_client_timezone", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 65 - } + "lineNumber": 61 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.num_lines_analyzed", "type": "number", + "tags": [], "label": "num_lines_analyzed", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 66 - } + "lineNumber": 62 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.column_names", "type": "Array", + "tags": [], "label": "column_names", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 67 + "lineNumber": 63 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.explanation", "type": "Array", + "tags": [], "label": "explanation", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 68 + "lineNumber": 64 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.grok_pattern", "type": "string", + "tags": [], "label": "grok_pattern", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 69 + "lineNumber": 65 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.multiline_start_pattern", "type": "string", + "tags": [], "label": "multiline_start_pattern", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 70 + "lineNumber": 66 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.exclude_lines_pattern", "type": "string", + "tags": [], "label": "exclude_lines_pattern", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 71 + "lineNumber": 67 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.java_timestamp_formats", "type": "Array", + "tags": [], "label": "java_timestamp_formats", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 72 + "lineNumber": 68 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.joda_timestamp_formats", "type": "Array", + "tags": [], "label": "joda_timestamp_formats", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 73 + "lineNumber": 69 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.timestamp_field", "type": "string", + "tags": [], "label": "timestamp_field", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 74 + "lineNumber": 70 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureResponse.should_trim_fields", "type": "CompoundType", + "tags": [], "label": "should_trim_fields", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 75 + "lineNumber": 71 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.HasImportPermission", "type": "Interface", + "tags": [], "label": "HasImportPermission", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 92 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.HasImportPermission.hasImportPermission", "type": "boolean", + "tags": [], "label": "hasImportPermission", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 12 - } + "lineNumber": 93 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.ImportFailure", "type": "Interface", + "tags": [], "label": "ImportFailure", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 111 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportFailure.item", "type": "number", + "tags": [], "label": "item", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 94 - } + "lineNumber": 112 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportFailure.reason", "type": "string", + "tags": [], "label": "reason", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 95 - } + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportFailure.doc", "type": "CompoundType", + "tags": [], "label": "doc", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 96 - }, "signature": [ { "pluginId": "fileUpload", @@ -2127,93 +1531,107 @@ "section": "def-common.ImportDoc", "text": "ImportDoc" } - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 114 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 93 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.ImportResponse", "type": "Interface", + "tags": [], "label": "ImportResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportResponse.success", "type": "boolean", + "tags": [], "label": "success", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 81 - } + "lineNumber": 99 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportResponse.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 82 - } + "lineNumber": 100 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportResponse.index", "type": "string", + "tags": [], "label": "index", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 83 + "lineNumber": 101 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportResponse.pipelineId", "type": "string", + "tags": [], "label": "pipelineId", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 84 + "lineNumber": 102 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportResponse.docCount", "type": "number", + "tags": [], "label": "docCount", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 85 - } + "lineNumber": 103 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportResponse.failures", "type": "Array", + "tags": [], "label": "failures", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 86 - }, "signature": [ { "pluginId": "fileUpload", @@ -2223,112 +1641,128 @@ "text": "ImportFailure" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 104 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportResponse.error", "type": "Object", + "tags": [], "label": "error", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 87 - }, "signature": [ "{ error: ", "ErrorCause", "; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 105 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ImportResponse.ingestError", "type": "CompoundType", + "tags": [], "label": "ingestError", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 90 + "lineNumber": 108 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 80 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.IngestPipeline", "type": "Interface", + "tags": [], "label": "IngestPipeline", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 144 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.IngestPipeline.description", "type": "string", + "tags": [], "label": "description", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 127 - } + "lineNumber": 145 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.IngestPipeline.processors", "type": "Array", + "tags": [], "label": "processors", "description": [], + "signature": [ + "any[]" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 128 + "lineNumber": 146 }, - "signature": [ - "any[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 126 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.IngestPipelineWrapper", "type": "Interface", + "tags": [], "label": "IngestPipelineWrapper", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 139 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.IngestPipelineWrapper.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 122 - } + "lineNumber": 140 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.IngestPipelineWrapper.pipeline", "type": "Object", + "tags": [], "label": "pipeline", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 123 - }, "signature": [ { "pluginId": "fileUpload", @@ -2337,210 +1771,234 @@ "section": "def-common.IngestPipeline", "text": "IngestPipeline" } - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 141 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 121 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.InputOverrides", "type": "Interface", + "tags": [], "label": "InputOverrides", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fileUpload", "id": "def-common.InputOverrides.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 16 + "lineNumber": 12 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.Mappings", "type": "Interface", + "tags": [], "label": "Mappings", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 130 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.Mappings._meta", "type": "Object", + "tags": [], "label": "_meta", "description": [], + "signature": [ + "{ created_by: string; } | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 113 + "lineNumber": 131 }, - "signature": [ - "{ created_by: string; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.Mappings.properties", "type": "Object", + "tags": [], "label": "properties", "description": [], + "signature": [ + "{ [key: string]: any; }" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 116 + "lineNumber": 134 }, - "signature": [ - "{ [key: string]: any; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 112 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.Settings", "type": "Interface", + "tags": [], "label": "Settings", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 123 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.Settings.pipeline", "type": "string", + "tags": [], "label": "pipeline", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 106 + "lineNumber": 124 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.Settings.index", "type": "string", + "tags": [], "label": "index", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 107 - } + "lineNumber": 125 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.Settings.body", "type": "Array", + "tags": [], "label": "body", "description": [], + "signature": [ + "any[]" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 108 + "lineNumber": 126 }, - "signature": [ - "any[]" - ] + "deprecated": false }, { + "parentPluginId": "fileUpload", "id": "def-common.Settings.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 109 + "lineNumber": 127 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 105 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.ABSOLUTE_MAX_FILE_SIZE_BYTES", "type": "number", + "tags": [], "label": "ABSOLUTE_MAX_FILE_SIZE_BYTES", "description": [], + "signature": [ + "1073741274" + ], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", "lineNumber": 14 }, - "signature": [ - "1073741274" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.FILE_SIZE_DISPLAY_FORMAT", "type": "string", + "tags": [], "label": "FILE_SIZE_DISPLAY_FORMAT", "description": [], + "signature": [ + "\"0,0.[0] b\"" + ], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", "lineNumber": 15 }, - "signature": [ - "\"0,0.[0] b\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.FormattedOverrides", "type": "Type", - "label": "FormattedOverrides", "tags": [], + "label": "FormattedOverrides", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 19 - }, "signature": [ "InputOverrides & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }" ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 15 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.ImportDoc", "type": "Type", - "label": "ImportDoc", "tags": [], + "label": "ImportDoc", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 103 - }, "signature": [ "string | object | ", { @@ -2551,93 +2009,110 @@ "text": "Doc" } ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 121 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.INDEX_META_DATA_CREATED_BY", "type": "string", + "tags": [], "label": "INDEX_META_DATA_CREATED_BY", "description": [], + "signature": [ + "\"file-data-visualizer\"" + ], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", "lineNumber": 19 }, - "signature": [ - "\"ml-file-data-visualizer\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.InputData", "type": "Type", - "label": "InputData", "tags": [], + "label": "InputData", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 78 - }, "signature": [ "any[]" ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 96 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.MAX_FILE_SIZE", "type": "string", + "tags": [], "label": "MAX_FILE_SIZE", "description": [], + "signature": [ + "\"100MB\"" + ], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", "lineNumber": 11 }, - "signature": [ - "\"100MB\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.MAX_FILE_SIZE_BYTES", "type": "number", + "tags": [], "label": "MAX_FILE_SIZE_BYTES", "description": [], + "signature": [ + "104857600" + ], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", "lineNumber": 12 }, - "signature": [ - "104857600" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.MB", "type": "number", + "tags": [], "label": "MB", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", "lineNumber": 10 }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-common.UI_SETTING_MAX_FILE_SIZE", "type": "string", + "tags": [], "label": "UI_SETTING_MAX_FILE_SIZE", "description": [], + "signature": [ + "\"fileUpload:maxFileSize\"" + ], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", "lineNumber": 8 }, - "signature": [ - "\"fileUpload:maxFileSize\"" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index f17e9c2472c12..aa4af1121e118 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -19,9 +19,6 @@ import fileUploadObj from './file_upload.json'; ### Interfaces -### Consts, variables and types - - ## Common ### Interfaces diff --git a/api_docs/fleet.json b/api_docs/fleet.json index a0f9d248fc94c..a1ac222cd16bb 100644 --- a/api_docs/fleet.json +++ b/api_docs/fleet.json @@ -4,60 +4,68 @@ "classes": [], "functions": [ { + "parentPluginId": "fleet", "id": "def-public.pkgKeyFromPackageInfo", "type": "Function", + "tags": [], + "label": "pkgKeyFromPackageInfo", + "description": [], + "signature": [ + "(packageInfo: T) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pkgKeyFromPackageInfo.$1", "type": "Uncategorized", + "tags": [], "label": "packageInfo", - "isRequired": true, + "description": [], "signature": [ "T" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(packageInfo: T) => string" - ], - "description": [], - "label": "pkgKeyFromPackageInfo", - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts", - "lineNumber": 8 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "fleet", "id": "def-public.AgentDetailsReassignPolicyAction", "type": "Interface", + "tags": [], "label": "AgentDetailsReassignPolicyAction", "description": [ "\nSupported routing state for the agent policy details page routes with deploy agents action" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.AgentDetailsReassignPolicyAction.onDoneNavigateTo", "type": "Object", + "tags": [], "label": "onDoneNavigateTo", "description": [ "On done, navigate to the given app" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", - "lineNumber": 39 - }, "signature": [ "[appId: string, options?: ", { @@ -68,36 +76,40 @@ "text": "NavigateToAppOptions" }, " | undefined] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 39 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", - "lineNumber": 37 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.AgentPolicyDetailsDeployAgentAction", "type": "Interface", + "tags": [], "label": "AgentPolicyDetailsDeployAgentAction", "description": [ "\nSupported routing state for the agent policy details page routes with deploy agents action" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.AgentPolicyDetailsDeployAgentAction.onDoneNavigateTo", "type": "Object", + "tags": [], "label": "onDoneNavigateTo", "description": [ "On done, navigate to the given app" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", - "lineNumber": 31 - }, "signature": [ "[appId: string, options?: ", { @@ -108,36 +120,40 @@ "text": "NavigateToAppOptions" }, " | undefined] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 31 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.CreatePackagePolicyRouteState", "type": "Interface", + "tags": [], "label": "CreatePackagePolicyRouteState", "description": [ "\nSupported routing state for the create package policy page routes" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.CreatePackagePolicyRouteState.onSaveNavigateTo", "type": "CompoundType", + "tags": [], "label": "onSaveNavigateTo", "description": [ "On a successful save of the package policy, use navigate to the given app" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", - "lineNumber": 17 - }, "signature": [ "[appId: string, options?: ", { @@ -164,20 +180,22 @@ "text": "NavigateToAppOptions" }, " | undefined]) | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.CreatePackagePolicyRouteState.onCancelNavigateTo", "type": "Object", + "tags": [], "label": "onCancelNavigateTo", "description": [ "On cancel, navigate to the given app" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", - "lineNumber": 21 - }, "signature": [ "[appId: string, options?: ", { @@ -188,117 +206,135 @@ "text": "NavigateToAppOptions" }, " | undefined] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.CreatePackagePolicyRouteState.onCancelUrl", "type": "string", + "tags": [], "label": "onCancelUrl", "description": [ "Url to be used on cancel links" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", "lineNumber": 23 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", - "lineNumber": 15 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.NewPackagePolicy", "type": "Interface", + "tags": [], "label": "NewPackagePolicy", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.NewPackagePolicy.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 50 - } + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.NewPackagePolicy.description", "type": "string", + "tags": [], "label": "description", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 51 + "lineNumber": 52 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.NewPackagePolicy.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 52 - } + "lineNumber": 53 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.NewPackagePolicy.enabled", "type": "boolean", + "tags": [], "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 53 - } + "lineNumber": 54 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.NewPackagePolicy.policy_id", "type": "string", + "tags": [], "label": "policy_id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 54 - } + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.NewPackagePolicy.output_id", "type": "string", + "tags": [], "label": "output_id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 55 - } + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.NewPackagePolicy.package", "type": "Object", + "tags": [], "label": "package", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 56 - }, "signature": [ { "pluginId": "fleet", @@ -308,18 +344,20 @@ "text": "PackagePolicyPackage" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 57 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.NewPackagePolicy.inputs", "type": "Array", + "tags": [], "label": "inputs", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 57 - }, "signature": [ { "pluginId": "fleet", @@ -329,59 +367,67 @@ "text": "NewPackagePolicyInput" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 58 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 49 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.PackageCustomExtension", "type": "Interface", + "tags": [], "label": "PackageCustomExtension", "description": [ "Extension point registration contract for Integration details Custom view" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 94 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackageCustomExtension.package", "type": "string", + "tags": [], "label": "package", "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", "lineNumber": 95 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackageCustomExtension.view", "type": "string", + "tags": [], "label": "view", "description": [], + "signature": [ + "\"package-detail-custom\"" + ], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", "lineNumber": 96 }, - "signature": [ - "\"package-detail-custom\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackageCustomExtension.component", "type": "Function", + "tags": [], "label": "component", "description": [], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 97 - }, "signature": [ "React.LazyExoticComponent>" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 97 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 94 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.PackageCustomExtensionComponentProps", "type": "Interface", + "tags": [], "label": "PackageCustomExtensionComponentProps", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 87 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackageCustomExtensionComponentProps.pkgkey", "type": "string", + "tags": [], "label": "pkgkey", "description": [ "The package key value that should be used used for URLs" @@ -419,18 +473,16 @@ "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", "lineNumber": 89 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackageCustomExtensionComponentProps.packageInfo", "type": "CompoundType", + "tags": [], "label": "packageInfo", "description": [], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 90 - }, "signature": [ { "pluginId": "fleet", @@ -439,59 +491,67 @@ "section": "def-common.PackageInfo", "text": "PackageInfo" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 90 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 87 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.PackagePolicyCreateExtension", "type": "Interface", + "tags": [], "label": "PackagePolicyCreateExtension", "description": [ "Extension point registration contract for Integration Policy Create views" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 76 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyCreateExtension.package", "type": "string", + "tags": [], "label": "package", "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", "lineNumber": 77 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyCreateExtension.view", "type": "string", + "tags": [], "label": "view", "description": [], + "signature": [ + "\"package-policy-create\"" + ], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", "lineNumber": 78 }, - "signature": [ - "\"package-policy-create\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyCreateExtension.component", "type": "Function", + "tags": [], "label": "component", "description": [], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 79 - }, "signature": [ "React.LazyExoticComponent>" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 79 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 76 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.PackagePolicyCreateExtensionComponentProps", "type": "Interface", + "tags": [], "label": "PackagePolicyCreateExtensionComponentProps", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyCreateExtensionComponentProps.newPolicy", "type": "Object", + "tags": [], "label": "newPolicy", "description": [ "The integration policy being created" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 62 - }, "signature": [ { "pluginId": "fleet", @@ -538,20 +602,22 @@ "section": "def-common.NewPackagePolicy", "text": "NewPackagePolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 62 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange", "type": "Function", + "tags": [], "label": "onChange", "description": [ "\nA callback that should be executed anytime a change to the Integration Policy needs to\nbe reported back to the Fleet Policy Edit page" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 67 - }, "signature": [ "(opts: { isValid: boolean; updatedPolicy: ", { @@ -562,59 +628,67 @@ "text": "NewPackagePolicy" }, "; }) => void" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 67 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 60 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.PackagePolicyEditExtension", "type": "Interface", + "tags": [], "label": "PackagePolicyEditExtension", "description": [ "Extension point registration contract for Integration Policy Edit views" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyEditExtension.package", "type": "string", + "tags": [], "label": "package", "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", "lineNumber": 49 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyEditExtension.view", "type": "string", + "tags": [], "label": "view", "description": [], + "signature": [ + "\"package-policy-edit\"" + ], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", "lineNumber": 50 }, - "signature": [ - "\"package-policy-edit\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyEditExtension.component", "type": "Function", + "tags": [], "label": "component", "description": [], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 51 - }, "signature": [ "React.LazyExoticComponent>" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 51 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.PackagePolicyEditExtensionComponentProps", "type": "Interface", + "tags": [], "label": "PackagePolicyEditExtensionComponentProps", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyEditExtensionComponentProps.policy", "type": "Object", + "tags": [], "label": "policy", "description": [ "The current integration policy being edited" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 28 - }, "signature": [ { "pluginId": "fleet", @@ -661,20 +739,22 @@ "section": "def-common.PackagePolicy", "text": "PackagePolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 28 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyEditExtensionComponentProps.newPolicy", "type": "Object", + "tags": [], "label": "newPolicy", "description": [ "The new (updated) integration policy that will be saved" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 30 - }, "signature": [ { "pluginId": "fleet", @@ -683,20 +763,22 @@ "section": "def-common.NewPackagePolicy", "text": "NewPackagePolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 30 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.PackagePolicyEditExtensionComponentProps.onChange", "type": "Function", + "tags": [], "label": "onChange", "description": [ "\nA callback that should be executed anytime a change to the Integration Policy needs to\nbe reported back to the Fleet Policy Edit page.\n\n**NOTE:**\nthis callback will be recreated everytime the policy data changes, thus logic around its\ninvocation should take that into consideration in order to avoid an endless loop." ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 39 - }, "signature": [ "(opts: { isValid: boolean; updatedPolicy: Partial<", { @@ -707,60 +789,62 @@ "text": "NewPackagePolicy" }, ">; }) => void" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 39 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.UIExtensionsStorage", "type": "Interface", + "tags": [], "label": "UIExtensionsStorage", "description": [ "Internal storage for registered UI Extension Points" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.UIExtensionsStorage.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", "lineNumber": 17 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 16 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "fleet", "id": "def-public.AnyIntraAppRouteState", "type": "Type", - "label": "AnyIntraAppRouteState", "tags": [], + "label": "AnyIntraAppRouteState", "description": [ "\nAll possible Route states." ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", - "lineNumber": 45 - }, "signature": [ { "pluginId": "fleet", @@ -786,20 +870,22 @@ "text": "AgentDetailsReassignPolicyAction" } ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 45 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.PackageCustomExtensionComponent", "type": "Type", - "label": "PackageCustomExtensionComponent", "tags": [], + "label": "PackageCustomExtensionComponent", "description": [ "\nUI Component Extension is used to display a Custom tab (and view) under a given Integration" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 85 - }, "signature": [ "React.ComponentClass<", { @@ -819,20 +905,22 @@ }, ">" ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 85 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.PackagePolicyCreateExtensionComponent", "type": "Type", - "label": "PackagePolicyCreateExtensionComponent", "tags": [], + "label": "PackagePolicyCreateExtensionComponent", "description": [ "\nUI Component Extension is used on the pages displaying the ability to Create an\nIntegration Policy" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 58 - }, "signature": [ "React.ComponentClass<", { @@ -852,20 +940,22 @@ }, ">" ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 58 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.PackagePolicyEditExtensionComponent", "type": "Type", - "label": "PackagePolicyEditExtensionComponent", "tags": [], + "label": "PackagePolicyEditExtensionComponent", "description": [ "\nUI Component Extension is used on the pages displaying the ability to edit an\nIntegration Policy" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 24 - }, "signature": [ "React.ComponentClass<", { @@ -885,20 +975,22 @@ }, ">" ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 24 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.UIExtensionPoint", "type": "Type", - "label": "UIExtensionPoint", "tags": [], + "label": "UIExtensionPoint", "description": [ "Fleet UI Extension Point" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 101 - }, "signature": [ { "pluginId": "fleet", @@ -924,20 +1016,22 @@ "text": "PackagePolicyCreateExtension" } ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 101 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-public.UIExtensionRegistrationCallback", "type": "Type", - "label": "UIExtensionRegistrationCallback", "tags": [], + "label": "UIExtensionRegistrationCallback", "description": [ "Register a Fleet UI extension" ], - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", - "lineNumber": 13 - }, "signature": [ "(extensionPoint: ", { @@ -949,581 +1043,668 @@ }, ") => void" ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 13 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters", "type": "Object", "tags": [], + "label": "pagePathGetters", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.base", "type": "Function", - "children": [], + "tags": [], + "label": "base", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "base", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 75 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.overview", "type": "Function", - "children": [], + "tags": [], + "label": "overview", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "overview", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 76 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integrations", "type": "Function", - "children": [], + "tags": [], + "label": "integrations", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "integrations", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 77 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integrations_all", "type": "Function", - "children": [], + "tags": [], + "label": "integrations_all", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "integrations_all", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 78 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integrations_installed", "type": "Function", - "children": [], + "tags": [], + "label": "integrations_installed", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "integrations_installed", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 79 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integration_details_overview", "type": "Function", + "tags": [], + "label": "integration_details_overview", + "description": [], + "signature": [ + "({ pkgkey }: ", + "DynamicPagePathValues", + ") => string" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integration_details_overview.$1", "type": "Object", + "tags": [], "label": "{ pkgkey }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 80 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ pkgkey }: ", - "DynamicPagePathValues", - ") => string" - ], - "description": [], - "label": "integration_details_overview", - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 80 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integration_details_policies", "type": "Function", + "tags": [], + "label": "integration_details_policies", + "description": [], + "signature": [ + "({ pkgkey }: ", + "DynamicPagePathValues", + ") => string" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 81 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integration_details_policies.$1", "type": "Object", + "tags": [], "label": "{ pkgkey }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integration_details_settings", + "type": "Function", + "tags": [], + "label": "integration_details_settings", + "description": [], "signature": [ "({ pkgkey }: ", "DynamicPagePathValues", ") => string" ], - "description": [], - "label": "integration_details_policies", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 81 + "lineNumber": 82 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.pagePathGetters.integration_details_settings", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integration_details_settings.$1", "type": "Object", + "tags": [], "label": "{ pkgkey }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 82 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integration_details_custom", + "type": "Function", + "tags": [], + "label": "integration_details_custom", + "description": [], "signature": [ "({ pkgkey }: ", "DynamicPagePathValues", ") => string" ], - "description": [], - "label": "integration_details_settings", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 82 + "lineNumber": 83 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.pagePathGetters.integration_details_custom", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integration_details_custom.$1", "type": "Object", + "tags": [], "label": "{ pkgkey }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integration_policy_edit", + "type": "Function", + "tags": [], + "label": "integration_policy_edit", + "description": [], "signature": [ - "({ pkgkey }: ", + "({ packagePolicyId }: ", "DynamicPagePathValues", ") => string" ], - "description": [], - "label": "integration_details_custom", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 83 + "lineNumber": 84 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.pagePathGetters.integration_policy_edit", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integration_policy_edit.$1", "type": "Object", + "tags": [], "label": "{ packagePolicyId }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 84 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ packagePolicyId }: ", - "DynamicPagePathValues", - ") => string" - ], - "description": [], - "label": "integration_policy_edit", - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 84 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.policies", "type": "Function", - "children": [], + "tags": [], + "label": "policies", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "policies", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 86 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.policies_list", "type": "Function", - "children": [], + "tags": [], + "label": "policies_list", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "policies_list", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 87 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.policy_details", "type": "Function", + "tags": [], + "label": "policy_details", + "description": [], + "signature": [ + "({ policyId, tabId }: ", + "DynamicPagePathValues", + ") => string" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 88 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.policy_details.$1", "type": "Object", + "tags": [], "label": "{ policyId, tabId }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 88 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.add_integration_from_policy", + "type": "Function", + "tags": [], + "label": "add_integration_from_policy", + "description": [], "signature": [ - "({ policyId, tabId }: ", + "({ policyId }: ", "DynamicPagePathValues", ") => string" ], - "description": [], - "label": "policy_details", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 88 + "lineNumber": 89 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.pagePathGetters.add_integration_from_policy", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.add_integration_from_policy.$1", "type": "Object", + "tags": [], "label": "{ policyId }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 89 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.add_integration_to_policy", + "type": "Function", + "tags": [], + "label": "add_integration_to_policy", + "description": [], "signature": [ - "({ policyId }: ", + "({ pkgkey }: ", "DynamicPagePathValues", ") => string" ], - "description": [], - "label": "add_integration_from_policy", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 89 + "lineNumber": 90 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.pagePathGetters.add_integration_to_policy", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.add_integration_to_policy.$1", "type": "Object", + "tags": [], "label": "{ pkgkey }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 90 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.edit_integration", + "type": "Function", + "tags": [], + "label": "edit_integration", + "description": [], "signature": [ - "({ pkgkey }: ", + "({ policyId, packagePolicyId }: ", "DynamicPagePathValues", ") => string" ], - "description": [], - "label": "add_integration_to_policy", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 90 + "lineNumber": 91 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.pagePathGetters.edit_integration", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.edit_integration.$1", "type": "Object", + "tags": [], "label": "{ policyId, packagePolicyId }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 91 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ policyId, packagePolicyId }: ", - "DynamicPagePathValues", - ") => string" - ], - "description": [], - "label": "edit_integration", - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 91 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.fleet", "type": "Function", - "children": [], + "tags": [], + "label": "fleet", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "fleet", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 93 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.fleet_agent_list", "type": "Function", + "tags": [], + "label": "fleet_agent_list", + "description": [], + "signature": [ + "({ kuery }: ", + "DynamicPagePathValues", + ") => string" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 94 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.fleet_agent_list.$1", "type": "Object", + "tags": [], "label": "{ kuery }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 94 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.fleet_agent_details", + "type": "Function", + "tags": [], + "label": "fleet_agent_details", + "description": [], "signature": [ - "({ kuery }: ", + "({ agentId, tabId, logQuery }: ", "DynamicPagePathValues", ") => string" ], - "description": [], - "label": "fleet_agent_list", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 94 + "lineNumber": 95 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.pagePathGetters.fleet_agent_details", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.fleet_agent_details.$1", "type": "Object", + "tags": [], "label": "{ agentId, tabId, logQuery }", - "isRequired": true, + "description": [], "signature": [ "DynamicPagePathValues" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 95 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ agentId, tabId, logQuery }: ", - "DynamicPagePathValues", - ") => string" - ], - "description": [], - "label": "fleet_agent_details", - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 95 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.fleet_enrollment_tokens", "type": "Function", - "children": [], + "tags": [], + "label": "fleet_enrollment_tokens", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "fleet_enrollment_tokens", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 97 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-public.pagePathGetters.data_streams", "type": "Function", - "children": [], + "tags": [], + "label": "data_streams", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "data_streams", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", "lineNumber": 98 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "description": [], - "label": "pagePathGetters", - "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 69 - }, "initialIsOpen": false } ], "setup": { + "parentPluginId": "fleet", "id": "def-public.FleetSetup", "type": "Interface", + "tags": [], "label": "FleetSetup", "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 50 + "lineNumber": 51 }, + "deprecated": false, + "children": [], "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "fleet", "id": "def-public.FleetStart", "type": "Interface", + "tags": [], "label": "FleetStart", "description": [ "\nDescribes public Fleet plugin contract returned at the `start` stage." ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/public/plugin.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.FleetStart.registerExtension", "type": "Function", + "tags": [], "label": "registerExtension", "description": [], - "source": { - "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 56 - }, "signature": [ { "pluginId": "fleet", @@ -1532,27 +1713,30 @@ "section": "def-public.UIExtensionRegistrationCallback", "text": "UIExtensionRegistrationCallback" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/public/plugin.ts", + "lineNumber": 57 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-public.FleetStart.isInitialized", "type": "Function", + "tags": [], "label": "isInitialized", "description": [], + "signature": [ + "() => Promise" + ], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 57 + "lineNumber": 58 }, - "signature": [ - "() => Promise" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 55 - }, "lifecycle": "start", "initialIsOpen": true } @@ -1560,6 +1744,7 @@ "server": { "classes": [ { + "parentPluginId": "fleet", "id": "def-server.AgentNotFoundError", "type": "Class", "tags": [], @@ -1576,51 +1761,42 @@ " extends ", "IngestManagerError" ], - "children": [], "source": { "path": "x-pack/plugins/fleet/server/errors/index.ts", "lineNumber": 37 }, + "deprecated": false, + "children": [], "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "fleet", "id": "def-server.getRegistryUrl", "type": "Function", - "children": [], + "tags": [], + "label": "getRegistryUrl", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getRegistryUrl", "source": { "path": "x-pack/plugins/fleet/server/services/epm/registry/registry_url.ts", "lineNumber": 33 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-server.relativeDownloadUrlFromArtifact", "type": "Function", - "children": [ - { - "id": "def-server.relativeDownloadUrlFromArtifact.$1", - "type": "Uncategorized", - "label": "{\n identifier,\n decodedSha256,\n}", - "isRequired": true, - "signature": [ - "T" - ], - "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/artifacts/mappings.ts", - "lineNumber": 66 - } - } - ], + "tags": [], + "label": "relativeDownloadUrlFromArtifact", + "description": [], "signature": [ ">({ identifier, decodedSha256, }: T) => string" ], - "description": [], - "label": "relativeDownloadUrlFromArtifact", "source": { "path": "x-pack/plugins/fleet/server/services/artifacts/mappings.ts", "lineNumber": 64 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.relativeDownloadUrlFromArtifact.$1", + "type": "Uncategorized", + "tags": [], + "label": "{\n identifier,\n decodedSha256,\n}", + "description": [], + "signature": [ + "T" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/artifacts/mappings.ts", + "lineNumber": 66 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "fleet", "id": "def-server.AgentPolicyServiceInterface", "type": "Interface", + "tags": [], "label": "AgentPolicyServiceInterface", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 67 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.AgentPolicyServiceInterface.get", "type": "Function", + "tags": [], "label": "get", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 68 - }, "signature": [ "(soClient: Pick<", { @@ -1679,18 +1875,20 @@ "text": "AgentPolicy" }, " | null>" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 68 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.AgentPolicyServiceInterface.list", "type": "Function", + "tags": [], "label": "list", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 69 - }, "signature": [ "(soClient: Pick<", { @@ -1709,18 +1907,20 @@ "text": "AgentPolicy" }, "[]; total: number; page: number; perPage: number; }>" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 69 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.AgentPolicyServiceInterface.getDefaultAgentPolicyId", "type": "Function", + "tags": [], "label": "getDefaultAgentPolicyId", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 70 - }, "signature": [ "(soClient: Pick<", { @@ -1731,18 +1931,20 @@ "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Promise" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 70 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.AgentPolicyServiceInterface.getFullAgentPolicy", "type": "Function", + "tags": [], "label": "getFullAgentPolicy", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 71 - }, "signature": [ "(soClient: Pick<", { @@ -1761,45 +1963,59 @@ "text": "FullAgentPolicy" }, " | null>" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 71 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 67 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-server.AgentService", "type": "Interface", + "tags": [], "label": "AgentService", "description": [ "\nA service that provides exported functions that return information about an Agent" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.AgentService.getAgent", "type": "Function", + "tags": [], "label": "getAgent", "description": [ "\nGet an Agent by id" ], + "signature": [ + "typeof ", + "getAgentById" + ], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 49 }, - "signature": [ - "typeof ", - "getAgentById" - ] + "deprecated": false }, { + "parentPluginId": "fleet", "id": "def-server.AgentService.authenticateAgentWithAccessToken", "type": "Function", + "tags": [], "label": "authenticateAgentWithAccessToken", + "description": [ + "\nAuthenticate an agent with access toekn" + ], "signature": [ "(esClient: ", { @@ -1827,15 +2043,19 @@ }, ">" ], - "description": [ - "\nAuthenticate an agent with access toekn" - ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.AgentService.authenticateAgentWithAccessToken.$1", "type": "CompoundType", + "tags": [], "label": "esClient", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1845,17 +2065,20 @@ "text": "ElasticsearchClient" } ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-server.AgentService.authenticateAgentWithAccessToken.$2", "type": "Object", + "tags": [], "label": "request", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1866,24 +2089,25 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 53 - } + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-server.AgentService.getAgentStatusById", "type": "Function", + "tags": [], "label": "getAgentStatusById", + "description": [ + "\nReturn the status by the Agent's id" + ], "signature": [ "(esClient: ", { @@ -1903,15 +2127,19 @@ }, ">" ], - "description": [ - "\nReturn the status by the Agent's id" - ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.AgentService.getAgentStatusById.$1", "type": "CompoundType", + "tags": [], "label": "esClient", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1921,62 +2149,62 @@ "text": "ElasticsearchClient" } ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-server.AgentService.getAgentStatusById.$2", "type": "string", + "tags": [], "label": "agentId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 60 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.AgentService.listAgents", "type": "Function", + "tags": [], "label": "listAgents", "description": [ "\nList agents" ], + "signature": [ + "typeof ", + "getAgentsByKuery" + ], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 64 }, - "signature": [ - "typeof ", - "getAgentsByKuery" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 45 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-server.Artifact", "type": "Interface", + "tags": [], "label": "Artifact", + "description": [], "signature": [ { "pluginId": "fleet", @@ -1988,51 +2216,63 @@ " extends ", "NewArtifact" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.Artifact.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", "lineNumber": 34 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.Artifact.created", "type": "string", + "tags": [], "label": "created", "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", "lineNumber": 35 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", - "lineNumber": 33 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface", "type": "Interface", + "tags": [], "label": "ArtifactsClientInterface", "description": [ "\nThe interface exposed out of Fleet's Artifact service via the client class" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", + "lineNumber": 78 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.getArtifact", "type": "Function", + "tags": [], "label": "getArtifact", + "description": [], "signature": [ "(id: string) => Promise<", { @@ -2044,34 +2284,39 @@ }, " | undefined>" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", + "lineNumber": 79 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.getArtifact.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", "lineNumber": 79 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", - "lineNumber": 79 - } + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.createArtifact", "type": "Function", + "tags": [], "label": "createArtifact", + "description": [], "signature": [ "(options: ", "ArtifactsClientCreateOptions", @@ -2085,65 +2330,75 @@ }, ">" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", + "lineNumber": 81 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.createArtifact.$1", "type": "CompoundType", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ "ArtifactsClientCreateOptions" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", - "lineNumber": 81 - } + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.deleteArtifact", "type": "Function", + "tags": [], "label": "deleteArtifact", + "description": [], "signature": [ "(id: string) => Promise" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.deleteArtifact.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", "lineNumber": 83 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", - "lineNumber": 83 - } + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.listArtifacts", "type": "Function", + "tags": [], "label": "listArtifacts", + "description": [], "signature": [ "(options?: ", "ListArtifactsProps", @@ -2165,35 +2420,40 @@ }, ">>" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", + "lineNumber": 85 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.listArtifacts.$1", "type": "CompoundType", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ "ListArtifactsProps", " | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", "lineNumber": 85 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", - "lineNumber": 85 - } + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.encodeContent", "type": "Function", + "tags": [], "label": "encodeContent", + "description": [], "signature": [ "(content: string) => Promise>" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", + "lineNumber": 87 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.encodeContent.$1", "type": "string", + "tags": [], "label": "content", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", "lineNumber": 87 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", - "lineNumber": 87 - } + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.generateHash", "type": "Function", + "tags": [], "label": "generateHash", + "description": [], "signature": [ "(content: string) => string" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", + "lineNumber": 89 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.ArtifactsClientInterface.generateHash.$1", "type": "string", + "tags": [], "label": "content", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", "lineNumber": 89 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", - "lineNumber": 89 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/fleet/server/services/artifacts/types.ts", - "lineNumber": 78 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-server.ESIndexPatternService", "type": "Interface", + "tags": [], "label": "ESIndexPatternService", "description": [ "\nService to return the index pattern of EPM packages" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.ESIndexPatternService.getESIndexPattern", "type": "Function", + "tags": [], "label": "getESIndexPattern", + "description": [], "signature": [ "(savedObjectsClient: Pick<", { @@ -2291,13 +2563,19 @@ }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, pkgName: string, datasetPath: string) => Promise" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.ESIndexPatternService.getESIndexPattern.$1", "type": "Object", + "tags": [], "label": "savedObjectsClient", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -2309,72 +2587,73 @@ }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-server.ESIndexPatternService.getESIndexPattern.$2", "type": "string", + "tags": [], "label": "pkgName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-server.ESIndexPatternService.getESIndexPattern.$3", "type": "string", + "tags": [], "label": "datasetPath", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 24 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-server.FleetSetupDeps", "type": "Interface", + "tags": [], "label": "FleetSetupDeps", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 91 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetSetupDeps.licensing", "type": "Object", + "tags": [], "label": "licensing", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 96 - }, "signature": [ { "pluginId": "licensing", @@ -2383,18 +2662,20 @@ "section": "def-server.LicensingPluginSetup", "text": "LicensingPluginSetup" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 92 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetSetupDeps.security", "type": "Object", + "tags": [], "label": "security", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 97 - }, "signature": [ { "pluginId": "security", @@ -2404,18 +2685,20 @@ "text": "SecurityPluginSetup" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 93 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetSetupDeps.features", "type": "Object", + "tags": [], "label": "features", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 98 - }, "signature": [ { "pluginId": "features", @@ -2425,18 +2708,20 @@ "text": "PluginSetupContract" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 94 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetSetupDeps.encryptedSavedObjects", "type": "Object", + "tags": [], "label": "encryptedSavedObjects", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 99 - }, "signature": [ { "pluginId": "encryptedSavedObjects", @@ -2445,18 +2730,20 @@ "section": "def-server.EncryptedSavedObjectsPluginSetup", "text": "EncryptedSavedObjectsPluginSetup" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 95 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetSetupDeps.cloud", "type": "Object", + "tags": [], "label": "cloud", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 100 - }, "signature": [ { "pluginId": "cloud", @@ -2466,44 +2753,61 @@ "text": "CloudSetup" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 96 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetSetupDeps.usageCollection", "type": "Object", + "tags": [], "label": "usageCollection", "description": [], + "signature": [ + { + "pluginId": "usageCollection", + "scope": "server", + "docId": "kibUsageCollectionPluginApi", + "section": "def-server.UsageCollectionSetup", + "text": "UsageCollectionSetup" + }, + " | undefined" + ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 101 + "lineNumber": 97 }, - "signature": [ - "Pick<", - "CollectorSet", - ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 95 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-server.PackageService", "type": "Interface", + "tags": [], "label": "PackageService", "description": [ "\nService that provides exported function that return information about EPM packages" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.PackageService.getInstalledEsAssetReferences", "type": "Function", + "tags": [], "label": "getInstalledEsAssetReferences", + "description": [], "signature": [ "(savedObjectsClient: Pick<", { @@ -2523,13 +2827,19 @@ }, "[]>" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-server.PackageService.getInstalledEsAssetReferences.$1", "type": "Object", + "tags": [], "label": "savedObjectsClient", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -2541,56 +2851,48 @@ }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 37 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-server.PackageService.getInstalledEsAssetReferences.$2", "type": "string", + "tags": [], "label": "pkgName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 36 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 35 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "fleet", "id": "def-server.ExternalCallback", "type": "Type", - "label": "ExternalCallback", "tags": [], + "label": "ExternalCallback", "description": [ "\nCallbacks supported by the Fleet plugin" ], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 141 - }, "signature": [ "[\"packagePolicyCreate\", (newPackagePolicy: ", { @@ -2633,107 +2935,125 @@ "text": "UpdatePackagePolicy" } ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 137 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-server.FleetConfigType", "type": "Type", - "label": "FleetConfigType", "tags": [], + "label": "FleetConfigType", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/index.ts", - "lineNumber": 83 - }, "signature": [ "any" ], + "source": { + "path": "x-pack/plugins/fleet/server/index.ts", + "lineNumber": 66 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-server.PackagePolicyServiceInterface", "type": "Type", - "label": "PackagePolicyServiceInterface", "tags": [], + "label": "PackagePolicyServiceInterface", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", - "lineNumber": 592 - }, "signature": [ "PackagePolicyService" ], + "source": { + "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "lineNumber": 648 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.agent", "type": "Object", + "tags": [], "label": "agent", "description": [], + "signature": [ + "Agent" + ], "source": { "path": "node_modules/elastic-apm-node/index.d.ts", "lineNumber": 7 }, - "signature": [ - "Agent" - ], + "deprecated": false, "initialIsOpen": false } ], "setup": { + "parentPluginId": "fleet", "id": "def-server.FleetSetupContract", "type": "Type", - "label": "FleetSetupContract", "tags": [], + "label": "FleetSetupContract", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 126 - }, "signature": [ "void" ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 122 + }, + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "fleet", "id": "def-server.FleetStartContract", "type": "Interface", + "tags": [], "label": "FleetStartContract", "description": [ "\nDescribes public Fleet plugin contract returned at the `startup` stage." ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 160 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetStartContract.fleetSetupCompleted", "type": "Function", + "tags": [], "label": "fleetSetupCompleted", "description": [ "\nreturns a promise that resolved when fleet setup has been completed regardless if it was successful or failed).\nAny consumer of fleet start services should first `await` for this promise to be resolved before using those\nservices" ], + "signature": [ + "() => Promise" + ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 170 + "lineNumber": 166 }, - "signature": [ - "() => Promise" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetStartContract.esIndexPatternService", "type": "Object", + "tags": [], "label": "esIndexPatternService", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 171 - }, "signature": [ { "pluginId": "fleet", @@ -2742,18 +3062,20 @@ "section": "def-server.ESIndexPatternService", "text": "ESIndexPatternService" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 167 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetStartContract.packageService", "type": "Object", + "tags": [], "label": "packageService", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 172 - }, "signature": [ { "pluginId": "fleet", @@ -2762,18 +3084,20 @@ "section": "def-server.PackageService", "text": "PackageService" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 168 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetStartContract.agentService", "type": "Object", + "tags": [], "label": "agentService", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 173 - }, "signature": [ { "pluginId": "fleet", @@ -2782,34 +3106,38 @@ "section": "def-server.AgentService", "text": "AgentService" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 169 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetStartContract.packagePolicyService", "type": "Object", + "tags": [], "label": "packagePolicyService", "description": [ "\nServices for Fleet's package policies" ], + "signature": [ + "PackagePolicyService" + ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 177 + "lineNumber": 173 }, - "signature": [ - "PackagePolicyService" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetStartContract.agentPolicyService", "type": "Object", + "tags": [], "label": "agentPolicyService", "description": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 178 - }, "signature": [ { "pluginId": "fleet", @@ -2818,20 +3146,22 @@ "section": "def-server.AgentPolicyServiceInterface", "text": "AgentPolicyServiceInterface" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 174 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetStartContract.registerExternalCallback", "type": "Function", + "tags": [], "label": "registerExternalCallback", "description": [ "\nRegister callbacks for inclusion in fleet API processing" ], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 183 - }, "signature": [ "(...args: ", { @@ -2842,30 +3172,33 @@ "text": "ExternalCallback" }, ") => void" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 179 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-server.FleetStartContract.createArtifactsClient", "type": "Function", + "tags": [], "label": "createArtifactsClient", "description": [ "\nCreate a Fleet Artifact Client instance" ], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 189 - }, "signature": [ "(packageName: string) => ", "FleetArtifactsClient" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 185 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 164 - }, "lifecycle": "start", "initialIsOpen": true } @@ -2873,16 +3206,25 @@ "common": { "classes": [ { + "parentPluginId": "fleet", "id": "def-common.LicenseService", "type": "Class", "tags": [], "label": "LicenseService", "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/license.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.LicenseService.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(license$: ", "Observable", @@ -2890,71 +3232,80 @@ "ILicense", ">) => void" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/license.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.LicenseService.start.$1", "type": "Object", + "tags": [], "label": "license$", - "isRequired": true, + "description": [], "signature": [ "Observable", "<", "ILicense", ">" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/license.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/common/services/license.ts", - "lineNumber": 23 - } + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.LicenseService.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/fleet/common/services/license.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.LicenseService.getLicenseInformation", "type": "Function", + "tags": [], "label": "getLicenseInformation", + "description": [], "signature": [ "() => ", "ILicense", " | null" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/fleet/common/services/license.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.LicenseService.getLicenseInformation$", "type": "Function", + "tags": [], "label": "getLicenseInformation$", + "description": [], "signature": [ "() => ", "Observable", @@ -2962,97 +3313,123 @@ "ILicense", "> | null" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/fleet/common/services/license.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.LicenseService.isGoldPlus", "type": "Function", + "tags": [], "label": "isGoldPlus", + "description": [], "signature": [ "() => boolean | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/fleet/common/services/license.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.LicenseService.isEnterprise", "type": "Function", + "tags": [], "label": "isEnterprise", + "description": [], "signature": [ "() => boolean | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/fleet/common/services/license.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/fleet/common/services/license.ts", - "lineNumber": 14 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "fleet", "id": "def-common.decodeCloudId", "type": "Function", + "tags": [], "label": "decodeCloudId", + "description": [], "signature": [ "(cid: string) => { host: string; defaultPort: string; elasticsearchUrl: string; kibanaUrl: string; } | undefined" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.decodeCloudId.$1", "type": "string", + "tags": [], "label": "cid", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts", "lineNumber": 10 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.doesAgentPolicyAlreadyIncludePackage", "type": "Function", + "tags": [], + "label": "doesAgentPolicyAlreadyIncludePackage", + "description": [], + "signature": [ + "(agentPolicy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + }, + ", packageName: string) => boolean" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/limited_package.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.doesAgentPolicyAlreadyIncludePackage.$1", "type": "Object", + "tags": [], "label": "agentPolicy", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "fleet", @@ -3062,72 +3439,82 @@ "text": "AgentPolicy" } ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/limited_package.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-common.doesAgentPolicyAlreadyIncludePackage.$2", "type": "string", + "tags": [], "label": "packageName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/limited_package.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentPolicy: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" - }, - ", packageName: string) => boolean" - ], - "description": [], - "label": "doesAgentPolicyAlreadyIncludePackage", - "source": { - "path": "x-pack/plugins/fleet/common/services/limited_package.ts", - "lineNumber": 15 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.entries", "type": "Function", + "tags": [], "label": "entries", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 42 - }, "signature": [ "(o: T) => [keyof T, T[keyof T]][]" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 44 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.fullAgentPolicyToYaml", "type": "Function", + "tags": [], + "label": "fullAgentPolicyToYaml", + "description": [], + "signature": [ + "(policy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicy", + "text": "FullAgentPolicy" + }, + ") => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.fullAgentPolicyToYaml.$1", "type": "Object", + "tags": [], "label": "policy", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "fleet", @@ -3137,38 +3524,24 @@ "text": "FullAgentPolicy" } ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(policy: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicy", - "text": "FullAgentPolicy" - }, - ") => string" - ], - "description": [], - "label": "fullAgentPolicyToYaml", - "source": { - "path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts", - "lineNumber": 28 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.isAgentUpgradeable", "type": "Function", + "tags": [], "label": "isAgentUpgradeable", + "description": [], "signature": [ "(agent: ", { @@ -3180,13 +3553,19 @@ }, ", kibanaVersion: string) => boolean" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.isAgentUpgradeable.$1", "type": "Object", + "tags": [], "label": "agent", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "fleet", @@ -3196,76 +3575,102 @@ "text": "Agent" } ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-common.isAgentUpgradeable.$2", "type": "string", + "tags": [], "label": "kibanaVersion", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.isDiffPathProtocol", "type": "Function", + "tags": [], "label": "isDiffPathProtocol", + "description": [], "signature": [ "(kibanaUrls: string[]) => boolean" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.isDiffPathProtocol.$1", "type": "Array", + "tags": [], "label": "kibanaUrls", - "isRequired": true, + "description": [], "signature": [ "string[]" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.isPackageLimited", "type": "Function", + "tags": [], + "label": "isPackageLimited", + "description": [], + "signature": [ + "(packageInfo: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageInfo", + "text": "PackageInfo" + }, + ") => boolean" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/limited_package.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.isPackageLimited.$1", "type": "CompoundType", + "tags": [], "label": "packageInfo", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "fleet", @@ -3275,75 +3680,94 @@ "text": "PackageInfo" } ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/limited_package.ts", "lineNumber": 11 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(packageInfo: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - }, - ") => boolean" - ], - "description": [], - "label": "isPackageLimited", - "source": { - "path": "x-pack/plugins/fleet/common/services/limited_package.ts", - "lineNumber": 11 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.isValidNamespace", "type": "Function", + "tags": [], "label": "isValidNamespace", + "description": [], "signature": [ "(namespace: string) => { valid: boolean; error?: string | undefined; }" ], - "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.isValidNamespace.$1", "type": "string", + "tags": [], "label": "namespace", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.packageToPackagePolicy", "type": "Function", + "tags": [], + "label": "packageToPackagePolicy", + "description": [ + "\nBuilds a `NewPackagePolicy` structure based on a package\n" + ], + "signature": [ + "(packageInfo: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageInfo", + "text": "PackageInfo" + }, + ", agentPolicyId: string, outputId: string, namespace?: string, packagePolicyName?: string | undefined, description?: string | undefined) => ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "lineNumber": 116 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.packageToPackagePolicy.$1", "type": "CompoundType", + "tags": [], "label": "packageInfo", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "fleet", @@ -3353,83 +3777,109 @@ "text": "PackageInfo" } ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", "lineNumber": 117 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-common.packageToPackagePolicy.$2", "type": "string", + "tags": [], "label": "agentPolicyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", "lineNumber": 118 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-common.packageToPackagePolicy.$3", "type": "string", + "tags": [], "label": "outputId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", "lineNumber": 119 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-common.packageToPackagePolicy.$4", "type": "string", + "tags": [], "label": "namespace", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", "lineNumber": 120 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "fleet", "id": "def-common.packageToPackagePolicy.$5", "type": "string", + "tags": [], "label": "packagePolicyName", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", "lineNumber": 121 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "fleet", "id": "def-common.packageToPackagePolicy.$6", "type": "string", + "tags": [], "label": "description", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", "lineNumber": 122 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.packageToPackagePolicyInputs", + "type": "Function", + "tags": [], + "label": "packageToPackagePolicyInputs", + "description": [], "signature": [ "(packageInfo: ", { @@ -3439,36 +3889,29 @@ "section": "def-common.PackageInfo", "text": "PackageInfo" }, - ", agentPolicyId: string, outputId: string, namespace?: string, packagePolicyName?: string | undefined, description?: string | undefined) => ", + ") => ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - } - ], - "description": [ - "\nBuilds a `NewPackagePolicy` structure based on a package\n" + "section": "def-common.NewPackagePolicyInput", + "text": "NewPackagePolicyInput" + }, + "[]" ], - "label": "packageToPackagePolicy", "source": { "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "lineNumber": 116 + "lineNumber": 46 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.packageToPackagePolicyInputs", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.packageToPackagePolicyInputs.$1", "type": "CompoundType", + "tags": [], "label": "packageInfo", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "fleet", @@ -3478,51 +3921,56 @@ "text": "PackageInfo" } ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.storedPackagePoliciesToAgentInputs", + "type": "Function", + "tags": [], + "label": "storedPackagePoliciesToAgentInputs", + "description": [], "signature": [ - "(packageInfo: ", + "(packagePolicies: ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" }, - ") => ", + "[]) => ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicyInput", - "text": "NewPackagePolicyInput" + "section": "def-common.FullAgentPolicyInput", + "text": "FullAgentPolicyInput" }, "[]" ], - "description": [], - "label": "packageToPackagePolicyInputs", "source": { - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "lineNumber": 46 + "path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts", + "lineNumber": 11 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.storedPackagePoliciesToAgentInputs", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.storedPackagePoliciesToAgentInputs.$1", "type": "Array", + "tags": [], "label": "packagePolicies", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "fleet", @@ -3533,146 +3981,113 @@ }, "[]" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "fleet", + "id": "def-common.Agent", + "type": "Interface", + "tags": [], + "label": "Agent", + "description": [], "signature": [ - "(packagePolicies: ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" + "section": "def-common.Agent", + "text": "Agent" }, - "[]) => ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicyInput", - "text": "FullAgentPolicyInput" - }, - "[]" + " extends AgentBase" ], - "description": [], - "label": "storedPackagePoliciesToAgentInputs", "source": { - "path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts", - "lineNumber": 11 + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 118 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "id": "def-common.Agent", - "type": "Interface", - "label": "Agent", - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Agent", - "text": "Agent" - }, - " extends AgentBase" - ], - "description": [], - "tags": [], + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Agent.id", "type": "string", - "label": "id", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 151 - } - }, - { "tags": [], - "id": "def-common.Agent.current_error_events", - "type": "Array", - "label": "current_error_events", + "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 152 + "lineNumber": 119 }, - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentEvent", - "text": "AgentEvent" - }, - "[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Agent.access_api_key", "type": "string", + "tags": [], "label": "access_api_key", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 153 + "lineNumber": 120 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Agent.status", "type": "string", + "tags": [], "label": "status", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 154 + "lineNumber": 121 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Agent.packages", "type": "Array", + "tags": [], "label": "packages", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 155 + "lineNumber": 122 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 150 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentAction", "type": "Interface", + "tags": [], "label": "AgentAction", + "description": [], "signature": [ { "pluginId": "fleet", @@ -3690,19 +4105,19 @@ "text": "NewAgentAction" } ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentAction.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 48 - }, "signature": [ { "pluginId": "fleet", @@ -3711,164 +4126,142 @@ "section": "def-common.AgentActionType", "text": "AgentActionType" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 48 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentAction.data", "type": "Any", + "tags": [], "label": "data", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 49 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentAction.sent_at", "type": "string", + "tags": [], "label": "sent_at", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 50 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentAction.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 51 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentAction.agent_id", "type": "string", + "tags": [], "label": "agent_id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 52 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentAction.created_at", "type": "string", + "tags": [], "label": "created_at", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 53 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentAction.ack_data", "type": "Any", + "tags": [], "label": "ack_data", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 54 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 47 - }, "initialIsOpen": false }, { - "id": "def-common.AgentEvent", + "parentPluginId": "fleet", + "id": "def-common.AgentMetadata", "type": "Interface", - "label": "AgentEvent", - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentEvent", - "text": "AgentEvent" - }, - " extends ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewAgentEvent", - "text": "NewAgentEvent" - } - ], - "description": [], "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.AgentEvent.id", - "type": "string", - "label": "id", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 123 - } - } - ], + "label": "AgentMetadata", + "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 122 + "lineNumber": 96 }, - "initialIsOpen": false - }, - { - "id": "def-common.AgentMetadata", - "type": "Interface", - "label": "AgentMetadata", - "description": [], - "tags": [], + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.AgentMetadata.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 129 + "lineNumber": 97 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 128 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentPolicy", "type": "Interface", + "tags": [], "label": "AgentPolicy", + "description": [], "signature": [ { "pluginId": "fleet", @@ -3886,30 +4279,32 @@ "text": "NewAgentPolicy" } ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicy.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicy.status", "type": "CompoundType", + "tags": [], "label": "status", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 29 - }, "signature": [ { "pluginId": "fleet", @@ -3919,18 +4314,20 @@ "text": "ValueOf" }, "<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicy.package_policies", "type": "CompoundType", + "tags": [], "label": "package_policies", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 30 - }, "signature": [ "string[] | ", { @@ -3941,63 +4338,75 @@ "text": "PackagePolicy" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 30 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicy.is_managed", "type": "boolean", + "tags": [], "label": "is_managed", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicy.updated_at", "type": "string", + "tags": [], "label": "updated_at", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicy.updated_by", "type": "string", + "tags": [], "label": "updated_by", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicy.revision", "type": "number", + "tags": [], "label": "revision", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 34 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentPolicyAction", "type": "Interface", + "tags": [], "label": "AgentPolicyAction", + "description": [], "signature": [ { "pluginId": "fleet", @@ -4015,30 +4424,32 @@ "text": "NewAgentAction" } ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicyAction.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 58 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicyAction.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 59 - }, "signature": [ { "pluginId": "fleet", @@ -4047,18 +4458,20 @@ "section": "def-common.AgentActionType", "text": "AgentActionType" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 59 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicyAction.data", "type": "Object", + "tags": [], "label": "data", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 60 - }, "signature": [ "{ policy: ", { @@ -4069,66 +4482,78 @@ "text": "FullAgentPolicy" }, "; }" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 60 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicyAction.policy_id", "type": "string", + "tags": [], "label": "policy_id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 63 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicyAction.policy_revision", "type": "number", + "tags": [], "label": "policy_revision", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 64 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicyAction.created_at", "type": "string", + "tags": [], "label": "created_at", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 65 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentPolicyAction.ack_data", "type": "Any", + "tags": [], "label": "ack_data", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 66 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentSOAttributes", "type": "Interface", + "tags": [], "label": "AgentSOAttributes", + "description": [], "signature": [ { "pluginId": "fleet", @@ -4139,86 +4564,80 @@ }, " extends AgentBase" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 125 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-common.AgentSOAttributes.current_error_events", - "type": "string", - "label": "current_error_events", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 159 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AgentSOAttributes.packages", "type": "Array", + "tags": [], "label": "packages", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 160 + "lineNumber": 126 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 158 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AssetParts", "type": "Interface", + "tags": [], "label": "AssetParts", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 221 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AssetParts.pkgkey", "type": "string", + "tags": [], "label": "pkgkey", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 217 - } + "lineNumber": 222 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AssetParts.dataset", "type": "string", + "tags": [], "label": "dataset", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 218 + "lineNumber": 223 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AssetParts.service", "type": "CompoundType", + "tags": [], "label": "service", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 219 - }, "signature": [ { "pluginId": "fleet", @@ -4227,18 +4646,20 @@ "section": "def-common.ServiceName", "text": "ServiceName" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 224 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AssetParts.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 220 - }, "signature": [ { "pluginId": "fleet", @@ -4247,135 +4668,139 @@ "section": "def-common.AssetType", "text": "AssetType" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 225 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AssetParts.file", "type": "string", + "tags": [], "label": "file", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 221 - } + "lineNumber": 226 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 216 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.BaseSettings", "type": "Interface", + "tags": [], "label": "BaseSettings", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.BaseSettings.has_seen_add_data_notice", "type": "CompoundType", + "tags": [], "label": "has_seen_add_data_notice", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", "lineNumber": 11 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { + "parentPluginId": "fleet", + "id": "def-common.BaseSettings.has_seen_fleet_migration_notice", + "type": "CompoundType", "tags": [], - "id": "def-common.BaseSettings.fleet_server_hosts", - "type": "Array", - "label": "fleet_server_hosts", + "label": "has_seen_fleet_migration_notice", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", "lineNumber": 12 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], - "id": "def-common.BaseSettings.kibana_urls", + "parentPluginId": "fleet", + "id": "def-common.BaseSettings.fleet_server_hosts", "type": "Array", - "label": "kibana_urls", + "tags": [], + "label": "fleet_server_hosts", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 14 - }, "signature": [ "string[]" - ] - }, - { - "tags": [], - "id": "def-common.BaseSettings.kibana_ca_sha256", - "type": "string", - "label": "kibana_ca_sha256", - "description": [], + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 15 + "lineNumber": 13 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.BulkInstallPackageInfo", "type": "Interface", + "tags": [], "label": "BulkInstallPackageInfo", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 93 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.BulkInstallPackageInfo.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 91 - } + "lineNumber": 94 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.BulkInstallPackageInfo.version", "type": "string", + "tags": [], "label": "version", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 92 - } + "lineNumber": 95 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.BulkInstallPackageInfo.result", "type": "Object", + "tags": [], "label": "result", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 93 - }, "signature": [ { "pluginId": "fleet", @@ -4384,60 +4809,68 @@ "section": "def-common.InstallResult", "text": "InstallResult" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 96 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 90 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.BulkInstallPackagesRequest", "type": "Interface", + "tags": [], "label": "BulkInstallPackagesRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 103 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.BulkInstallPackagesRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ packages: string[]; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 101 + "lineNumber": 104 }, - "signature": [ - "{ packages: string[]; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 100 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.BulkInstallPackagesResponse", "type": "Interface", + "tags": [], "label": "BulkInstallPackagesResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 99 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.BulkInstallPackagesResponse.response", "type": "Array", + "tags": [], "label": "response", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 97 - }, "signature": [ "(", { @@ -4456,118 +4889,136 @@ "text": "BulkInstallPackageInfo" }, ")[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 100 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 96 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CategorySummaryItem", "type": "Interface", + "tags": [], "label": "CategorySummaryItem", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 214 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CategorySummaryItem.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 210 - } + "lineNumber": 215 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CategorySummaryItem.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 211 - } + "lineNumber": 216 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CategorySummaryItem.count", "type": "number", + "tags": [], "label": "count", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 212 - } + "lineNumber": 217 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 209 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CheckPermissionsResponse", "type": "Interface", + "tags": [], "label": "CheckPermissionsResponse", "description": [], - "tags": [], - "children": [ - { - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 8 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", "id": "def-common.CheckPermissionsResponse.error", "type": "CompoundType", + "tags": [], "label": "error", "description": [], + "signature": [ + "\"MISSING_SECURITY\" | \"MISSING_SUPERUSER_ROLE\" | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", "lineNumber": 9 }, - "signature": [ - "\"MISSING_SECURITY\" | \"MISSING_SUPERUSER_ROLE\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CheckPermissionsResponse.success", "type": "boolean", + "tags": [], "label": "success", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", "lineNumber": 10 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", - "lineNumber": 8 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CopyAgentPolicyRequest", "type": "Interface", + "tags": [], "label": "CopyAgentPolicyRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CopyAgentPolicyRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 54 - }, "signature": [ "Pick<", { @@ -4578,32 +5029,36 @@ "text": "AgentPolicy" }, ", \"description\" | \"name\">" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 54 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CopyAgentPolicyResponse", "type": "Interface", + "tags": [], "label": "CopyAgentPolicyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CopyAgentPolicyResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 58 - }, "signature": [ { "pluginId": "fleet", @@ -4612,32 +5067,36 @@ "section": "def-common.AgentPolicy", "text": "AgentPolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 58 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 57 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CreateAgentPolicyRequest", "type": "Interface", + "tags": [], "label": "CreateAgentPolicyRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CreateAgentPolicyRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 38 - }, "signature": [ { "pluginId": "fleet", @@ -4646,32 +5105,36 @@ "section": "def-common.NewAgentPolicy", "text": "NewAgentPolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 38 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 37 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CreateAgentPolicyResponse", "type": "Interface", + "tags": [], "label": "CreateAgentPolicyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CreateAgentPolicyResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 42 - }, "signature": [ { "pluginId": "fleet", @@ -4680,57 +5143,65 @@ "section": "def-common.AgentPolicy", "text": "AgentPolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 42 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 41 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CreateFleetSetupResponse", "type": "Interface", + "tags": [], "label": "CreateFleetSetupResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CreateFleetSetupResponse.isInitialized", "type": "boolean", + "tags": [], "label": "isInitialized", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", "lineNumber": 9 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", - "lineNumber": 8 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CreatePackagePolicyRequest", "type": "Interface", + "tags": [], "label": "CreatePackagePolicyRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CreatePackagePolicyRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 36 - }, "signature": [ { "pluginId": "fleet", @@ -4739,32 +5210,36 @@ "section": "def-common.NewPackagePolicy", "text": "NewPackagePolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 36 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CreatePackagePolicyResponse", "type": "Interface", + "tags": [], "label": "CreatePackagePolicyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.CreatePackagePolicyResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 40 - }, "signature": [ { "pluginId": "fleet", @@ -4773,349 +5248,457 @@ "section": "def-common.PackagePolicy", "text": "PackagePolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 40 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 39 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DataStream", "type": "Interface", + "tags": [], "label": "DataStream", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DataStream.index", "type": "string", + "tags": [], "label": "index", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", "lineNumber": 9 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DataStream.dataset", "type": "string", + "tags": [], "label": "dataset", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", "lineNumber": 10 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DataStream.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", "lineNumber": 11 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DataStream.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DataStream.package", "type": "string", + "tags": [], "label": "package", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DataStream.package_version", "type": "string", + "tags": [], "label": "package_version", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DataStream.last_activity_ms", "type": "number", + "tags": [], "label": "last_activity_ms", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DataStream.size_in_bytes", "type": "number", + "tags": [], "label": "size_in_bytes", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DataStream.dashboards", "type": "Array", + "tags": [], "label": "dashboards", "description": [], + "signature": [ + "{ id: string; title: string; }[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", "lineNumber": 17 }, - "signature": [ - "{ id: string; title: string; }[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", - "lineNumber": 8 - }, "initialIsOpen": false }, { - "id": "def-common.DeleteAgentPolicyRequest", + "parentPluginId": "fleet", + "id": "def-common.DefaultPackagesInstallationError", "type": "Interface", - "label": "DeleteAgentPolicyRequest", - "description": [], "tags": [], + "label": "DefaultPackagesInstallationError", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", + "id": "def-common.DefaultPackagesInstallationError.installType", + "type": "CompoundType", "tags": [], - "id": "def-common.DeleteAgentPolicyRequest.body", - "type": "Object", - "label": "body", + "label": "installType", "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstallType", + "text": "InstallType" + } + ], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 62 + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 34 }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.DefaultPackagesInstallationError.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], "signature": [ - "{ agentPolicyId: string; }" - ] + "Error" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 35 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 61 - }, "initialIsOpen": false }, { - "id": "def-common.DeleteAgentPolicyResponse", + "parentPluginId": "fleet", + "id": "def-common.DeleteAgentPolicyRequest", "type": "Interface", - "label": "DeleteAgentPolicyResponse", - "description": [], "tags": [], - "children": [ - { - "tags": [], + "label": "DeleteAgentPolicyRequest", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 61 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.DeleteAgentPolicyRequest.body", + "type": "Object", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "{ agentPolicyId: string; }" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 62 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.DeleteAgentPolicyResponse", + "type": "Interface", + "tags": [], + "label": "DeleteAgentPolicyResponse", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 67 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", "id": "def-common.DeleteAgentPolicyResponse.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "lineNumber": 68 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DeleteAgentPolicyResponse.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "lineNumber": 69 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 67 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DeleteAgentRequest", "type": "Interface", + "tags": [], "label": "DeleteAgentRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 134 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DeleteAgentRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ agentId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 205 + "lineNumber": 135 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 204 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DeleteEnrollmentAPIKeyRequest", "type": "Interface", + "tags": [], "label": "DeleteEnrollmentAPIKeyRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DeleteEnrollmentAPIKeyRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ keyId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", "lineNumber": 36 }, - "signature": [ - "{ keyId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DeleteEnrollmentAPIKeyResponse", "type": "Interface", + "tags": [], "label": "DeleteEnrollmentAPIKeyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DeleteEnrollmentAPIKeyResponse.action", "type": "string", + "tags": [], "label": "action", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", "lineNumber": 42 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 41 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DeletePackagePoliciesRequest", "type": "Interface", + "tags": [], "label": "DeletePackagePoliciesRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DeletePackagePoliciesRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ packagePolicyIds: string[]; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "lineNumber": 50 }, - "signature": [ - "{ packagePolicyIds: string[]; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 49 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DeletePackageRequest", "type": "Interface", + "tags": [], "label": "DeletePackageRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 113 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DeletePackageRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ pkgkey: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 111 + "lineNumber": 114 }, - "signature": [ - "{ pkgkey: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 110 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DeletePackageResponse", "type": "Interface", + "tags": [], "label": "DeletePackageResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 119 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DeletePackageResponse.response", "type": "Array", + "tags": [], "label": "response", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 117 - }, "signature": [ { "pluginId": "fleet", @@ -5125,151 +5708,175 @@ "text": "AssetReference" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 120 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 116 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.EnrollmentAPIKey", "type": "Interface", + "tags": [], "label": "EnrollmentAPIKey", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EnrollmentAPIKey.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 9 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EnrollmentAPIKey.api_key_id", "type": "string", + "tags": [], "label": "api_key_id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 10 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EnrollmentAPIKey.api_key", "type": "string", + "tags": [], "label": "api_key", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 11 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EnrollmentAPIKey.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 12 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EnrollmentAPIKey.active", "type": "boolean", + "tags": [], "label": "active", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EnrollmentAPIKey.policy_id", "type": "string", + "tags": [], "label": "policy_id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 14 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EnrollmentAPIKey.created_at", "type": "string", + "tags": [], "label": "created_at", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 15 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", - "lineNumber": 8 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.EpmPackageAdditions", "type": "Interface", + "tags": [], "label": "EpmPackageAdditions", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 320 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EpmPackageAdditions.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 316 - } + "lineNumber": 321 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EpmPackageAdditions.latestVersion", "type": "string", + "tags": [], "label": "latestVersion", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 317 - } + "lineNumber": 322 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EpmPackageAdditions.assets", "type": "CompoundType", + "tags": [], "label": "assets", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 318 - }, "signature": [ { "pluginId": "fleet", @@ -5278,149 +5885,216 @@ "section": "def-common.AssetsGroupedByServiceByType", "text": "AssetsGroupedByServiceByType" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 323 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EpmPackageAdditions.removable", "type": "CompoundType", + "tags": [], "label": "removable", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 319 + "lineNumber": 324 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 315 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FleetConfigType", "type": "Interface", + "tags": [], "label": "FleetConfigType", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetConfigType.enabled", "type": "boolean", + "tags": [], "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 12 - } + "lineNumber": 13 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetConfigType.registryUrl", "type": "string", + "tags": [], "label": "registryUrl", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 13 + "lineNumber": 14 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetConfigType.registryProxyUrl", "type": "string", + "tags": [], "label": "registryProxyUrl", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 14 + "lineNumber": 15 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetConfigType.agents", "type": "Object", + "tags": [], "label": "agents", "description": [], + "signature": [ + "{ enabled: boolean; tlsCheckDisabled: boolean; pollingRequestTimeout: number; maxConcurrentConnections: number; kibana: { host?: string | string[] | undefined; ca_sha256?: string | undefined; }; elasticsearch: { host?: string | undefined; ca_sha256?: string | undefined; }; fleet_server?: { hosts?: string[] | undefined; } | undefined; agentPolicyRolloutRateLimitIntervalMs: number; agentPolicyRolloutRateLimitRequestPerInterval: number; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 15 + "lineNumber": 16 + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetConfigType.agentPolicies", + "type": "Array", + "tags": [], + "label": "agentPolicies", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PreconfiguredAgentPolicy", + "text": "PreconfiguredAgentPolicy" + }, + "[] | undefined" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 35 }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetConfigType.packages", + "type": "Array", + "tags": [], + "label": "packages", + "description": [], "signature": [ - "{ enabled: boolean; fleetServerEnabled: boolean; tlsCheckDisabled: boolean; pollingRequestTimeout: number; maxConcurrentConnections: number; kibana: { host?: string | string[] | undefined; ca_sha256?: string | undefined; }; elasticsearch: { host?: string | undefined; ca_sha256?: string | undefined; }; fleet_server?: { hosts?: string[] | undefined; } | undefined; agentPolicyRolloutRateLimitIntervalMs: number; agentPolicyRolloutRateLimitRequestPerInterval: number; }" - ] + "Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" + }, + ", \"name\" | \"version\">[] | undefined" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 36 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent", "type": "Interface", + "tags": [], "label": "FleetServerAgent", "description": [ "\nAn Elastic Agent that has enrolled into Fleet" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 134 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent._version", "type": "number", + "tags": [], "label": "_version", "description": [ "\nThe version of the document in the index" ], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 172 + "lineNumber": 138 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.shared_id", "type": "string", + "tags": [], "label": "shared_id", "description": [ "\nShared ID" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 176 + "lineNumber": 142 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [ "\nType" ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 180 - }, "signature": [ { "pluginId": "fleet", @@ -5429,124 +6103,140 @@ "section": "def-common.AgentType", "text": "AgentType" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 146 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.active", "type": "boolean", + "tags": [], "label": "active", "description": [ "\nActive flag" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 184 - } + "lineNumber": 150 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.enrolled_at", "type": "string", + "tags": [], "label": "enrolled_at", "description": [ "\nDate/time the Elastic Agent enrolled" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 188 - } + "lineNumber": 154 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.unenrolled_at", "type": "string", + "tags": [], "label": "unenrolled_at", "description": [ "\nDate/time the Elastic Agent unenrolled" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 192 + "lineNumber": 158 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.unenrollment_started_at", "type": "string", + "tags": [], "label": "unenrollment_started_at", "description": [ "\nDate/time the Elastic Agent unenrolled started" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 196 + "lineNumber": 162 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.upgraded_at", "type": "CompoundType", + "tags": [], "label": "upgraded_at", "description": [ "\nDate/time the Elastic Agent was last upgraded" ], + "signature": [ + "string | null | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 200 + "lineNumber": 166 }, - "signature": [ - "string | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.upgrade_started_at", "type": "CompoundType", + "tags": [], "label": "upgrade_started_at", "description": [ "\nDate/time the Elastic Agent started the current upgrade" ], + "signature": [ + "string | null | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 204 + "lineNumber": 170 }, - "signature": [ - "string | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.access_api_key_id", "type": "string", + "tags": [], "label": "access_api_key_id", "description": [ "\nID of the API key the Elastic Agent must used to contact Fleet Server" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 208 + "lineNumber": 174 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.agent", "type": "Object", + "tags": [], "label": "agent", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 209 - }, "signature": [ { "pluginId": "fleet", @@ -5556,20 +6246,22 @@ "text": "FleetServerAgentMetadata" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 175 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.user_provided_metadata", "type": "Object", + "tags": [], "label": "user_provided_metadata", "description": [ "\nUser provided metadata information for the Elastic Agent" ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 213 - }, "signature": [ { "pluginId": "fleet", @@ -5578,20 +6270,22 @@ "section": "def-common.AgentMetadata", "text": "AgentMetadata" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 179 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.local_metadata", "type": "Object", + "tags": [], "label": "local_metadata", "description": [ "\nLocal metadata information for the Elastic Agent" ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 217 - }, "signature": [ { "pluginId": "fleet", @@ -5600,450 +6294,512 @@ "section": "def-common.AgentMetadata", "text": "AgentMetadata" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 183 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.policy_id", "type": "string", + "tags": [], "label": "policy_id", "description": [ "\nThe policy ID for the Elastic Agent" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 221 + "lineNumber": 187 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.policy_revision_idx", "type": "CompoundType", + "tags": [], "label": "policy_revision_idx", "description": [ "\nThe current policy revision_idx for the Elastic Agent" ], + "signature": [ + "number | null | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 225 + "lineNumber": 191 }, - "signature": [ - "number | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.policy_coordinator_idx", "type": "number", + "tags": [], "label": "policy_coordinator_idx", "description": [ "\nThe current policy coordinator for the Elastic Agent" ], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 229 + "lineNumber": 195 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.last_updated", "type": "string", + "tags": [], "label": "last_updated", "description": [ "\nDate/time the Elastic Agent was last updated" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 233 + "lineNumber": 199 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.last_checkin", "type": "string", + "tags": [], "label": "last_checkin", "description": [ "\nDate/time the Elastic Agent checked in last time" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 237 + "lineNumber": 203 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.last_checkin_status", "type": "CompoundType", + "tags": [], "label": "last_checkin_status", "description": [ "\nLst checkin status" ], + "signature": [ + "\"online\" | \"error\" | \"updating\" | \"degraded\" | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 241 + "lineNumber": 207 }, - "signature": [ - "\"online\" | \"error\" | \"updating\" | \"degraded\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.default_api_key_id", "type": "string", + "tags": [], "label": "default_api_key_id", "description": [ "\nID of the API key the Elastic Agent uses to authenticate with elasticsearch" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 245 + "lineNumber": 211 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.default_api_key", "type": "string", + "tags": [], "label": "default_api_key", "description": [ "\nAPI key the Elastic Agent uses to authenticate with elasticsearch" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 249 + "lineNumber": 215 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.updated_at", "type": "string", + "tags": [], "label": "updated_at", "description": [ "\nDate/time the Elastic Agent was last updated" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 253 + "lineNumber": 219 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.packages", "type": "Array", + "tags": [], "label": "packages", "description": [ "\nPackages array" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 257 + "lineNumber": 223 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgent.action_seq_no", "type": "number", + "tags": [], "label": "action_seq_no", "description": [ "\nThe last acknowledged action sequence number for the Elastic Agent" ], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 261 + "lineNumber": 227 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 168 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction", "type": "Interface", + "tags": [], "label": "FleetServerAgentAction", "description": [ "\nAn Elastic Agent action" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 247 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction._id", "type": "string", + "tags": [], "label": "_id", "description": [ "\nThe unique identifier for action document" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 285 + "lineNumber": 251 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction._seq_no", "type": "number", + "tags": [], "label": "_seq_no", "description": [ "\nThe action sequence number" ], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 289 + "lineNumber": 255 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction.action_id", "type": "string", + "tags": [], "label": "action_id", "description": [ "\nThe unique identifier for the Elastic Agent action. There could be multiple documents with the same action_id if the action is split into two separate documents." ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 293 + "lineNumber": 259 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction.timestamp", "type": "string", + "tags": [], "label": "'@timestamp'", "description": [ "\nDate/time the action was created" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 297 + "lineNumber": 263 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction.expiration", "type": "string", + "tags": [], "label": "expiration", "description": [ "\nThe action expiration date/time" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 301 + "lineNumber": 267 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction.type", "type": "string", + "tags": [], "label": "type", "description": [ "\nThe action type. APP_ACTION is the value for the actions that suppose to be routed to the endpoints/beats." ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 305 + "lineNumber": 271 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction.input_id", "type": "string", + "tags": [], "label": "input_id", "description": [ "\nThe input identifier the actions should be routed to." ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 309 + "lineNumber": 275 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction.agents", "type": "Array", + "tags": [], "label": "agents", "description": [ "\nThe Agent IDs the action is intended for. No support for json.RawMessage with the current generator. Could be useful to lazy parse the agent ids" ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 313 + "lineNumber": 279 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction.data", "type": "Object", + "tags": [], "label": "data", "description": [ "\nThe opaque payload." ], + "signature": [ + "{ [k: string]: unknown; } | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 317 + "lineNumber": 283 }, - "signature": [ - "{ [k: string]: unknown; } | undefined" - ] + "deprecated": false }, { + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 320 + "lineNumber": 286 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 281 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentMetadata", "type": "Interface", + "tags": [], "label": "FleetServerAgentMetadata", "description": [ "\nAn Elastic Agent metadata" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 232 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentMetadata.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nThe unique identifier for the Elastic Agent" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 270 - } + "lineNumber": 236 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentMetadata.version", "type": "string", + "tags": [], "label": "version", "description": [ "\nThe version of the Elastic Agent" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 274 - } + "lineNumber": 240 + }, + "deprecated": false }, { + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentMetadata.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 275 + "lineNumber": 241 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 266 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FleetServerEnrollmentAPIKey", "type": "Interface", + "tags": [], "label": "FleetServerEnrollmentAPIKey", "description": [ "\nAn Elastic Agent enrollment API key" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerEnrollmentAPIKey.active", "type": "CompoundType", + "tags": [], "label": "active", "description": [ "\nTrue when the key is active" ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 29 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerEnrollmentAPIKey.api_key_id", "type": "string", + "tags": [], "label": "api_key_id", "description": [ "\nThe unique identifier for the enrollment key, currently xid" @@ -6051,12 +6807,14 @@ "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerEnrollmentAPIKey.api_key", "type": "string", + "tags": [], "label": "api_key", "description": [ "\nApi key" @@ -6064,116 +6822,132 @@ "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 37 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerEnrollmentAPIKey.name", "type": "string", + "tags": [], "label": "name", "description": [ "\nEnrollment key name" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 41 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerEnrollmentAPIKey.policy_id", "type": "string", + "tags": [], "label": "policy_id", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 42 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerEnrollmentAPIKey.expire_at", "type": "string", + "tags": [], "label": "expire_at", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 43 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerEnrollmentAPIKey.created_at", "type": "string", + "tags": [], "label": "created_at", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 44 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerEnrollmentAPIKey.updated_at", "type": "string", + "tags": [], "label": "updated_at", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 45 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FleetServerPolicy", "type": "Interface", + "tags": [], "label": "FleetServerPolicy", "description": [ "\nA policy that an Elastic Agent is attached to" ], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 113 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerPolicy.timestamp", "type": "string", + "tags": [], "label": "'@timestamp'", "description": [ "\nDate/time the policy revision was created" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 117 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerPolicy.policy_id", "type": "string", + "tags": [], "label": "policy_id", "description": [ "\nThe ID of the policy" @@ -6181,12 +6955,14 @@ "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 121 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerPolicy.revision_idx", "type": "number", + "tags": [], "label": "revision_idx", "description": [ "\nThe revision index of the policy" @@ -6194,12 +6970,14 @@ "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 125 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerPolicy.coordinator_idx", "type": "number", + "tags": [], "label": "coordinator_idx", "description": [ "\nThe coordinator index of the policy" @@ -6207,28 +6985,32 @@ "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 129 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerPolicy.data", "type": "Object", + "tags": [], "label": "data", "description": [ "\nThe opaque payload." ], + "signature": [ + "{ [k: string]: unknown; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 133 }, - "signature": [ - "{ [k: string]: unknown; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerPolicy.default_fleet_server", "type": "boolean", + "tags": [], "label": "default_fleet_server", "description": [ "\nTrue when this policy is the default policy to start Fleet Server" @@ -6236,43 +7018,45 @@ "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 139 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 113 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicy", "type": "Interface", + "tags": [], "label": "FullAgentPolicy", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 73 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicy.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 74 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicy.outputs", "type": "Object", + "tags": [], "label": "outputs", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 75 - }, "signature": [ "{ [key: string]: Pick<", { @@ -6283,18 +7067,20 @@ "text": "Output" }, ", \"type\" | \"hosts\" | \"ca_sha256\" | \"api_key\"> & { [key: string]: any; }; }" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 75 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicy.output_permissions", "type": "Object", + "tags": [], "label": "output_permissions", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 80 - }, "signature": [ "{ [output: string]: ", { @@ -6305,18 +7091,20 @@ "text": "FullAgentPolicyOutputPermissions" }, "; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 80 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicy.fleet", "type": "CompoundType", + "tags": [], "label": "fleet", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 83 - }, "signature": [ "{ hosts: string[]; } | { kibana: ", { @@ -6327,18 +7115,20 @@ "text": "FullAgentPolicyKibanaConfig" }, "; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 83 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicy.inputs", "type": "Array", + "tags": [], "label": "inputs", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 90 - }, "signature": [ { "pluginId": "fleet", @@ -6348,129 +7138,149 @@ "text": "FullAgentPolicyInput" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 90 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicy.revision", "type": "number", + "tags": [], "label": "revision", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 91 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicy.agent", "type": "Object", + "tags": [], "label": "agent", "description": [], + "signature": [ + "{ monitoring: { use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; } | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 92 }, - "signature": [ - "{ monitoring: { use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 73 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInput", "type": "Interface", + "tags": [], "label": "FullAgentPolicyInput", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInput.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 49 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInput.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 50 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInput.revision", "type": "number", + "tags": [], "label": "revision", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 51 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInput.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 52 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInput.data_stream", "type": "Object", + "tags": [], "label": "data_stream", "description": [], + "signature": [ + "{ namespace: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 53 }, - "signature": [ - "{ namespace: string; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInput.use_output", "type": "string", + "tags": [], "label": "use_output", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 54 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInput.meta", "type": "Object", + "tags": [], "label": "meta", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 55 - }, "signature": [ "{ [key: string]: unknown; package?: Pick<", { @@ -6481,18 +7291,20 @@ "text": "PackagePolicyPackage" }, ", \"name\" | \"version\"> | undefined; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInput.streams", "type": "Array", + "tags": [], "label": "streams", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 59 - }, "signature": [ { "pluginId": "fleet", @@ -6502,180 +7314,248 @@ "text": "FullAgentPolicyInputStream" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 59 + }, + "deprecated": false }, { + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInput.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 60 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInputStream", "type": "Interface", + "tags": [], "label": "FullAgentPolicyInputStream", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInputStream.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 40 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInputStream.data_stream", "type": "Object", + "tags": [], "label": "data_stream", "description": [], + "signature": [ + "{ dataset: string; type: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 41 }, - "signature": [ - "{ dataset: string; type: string; }" - ] + "deprecated": false }, { + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyInputStream.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 45 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 39 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyKibanaConfig", "type": "Interface", + "tags": [], "label": "FullAgentPolicyKibanaConfig", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 102 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyKibanaConfig.hosts", "type": "Array", + "tags": [], "label": "hosts", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 103 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyKibanaConfig.protocol", "type": "string", + "tags": [], "label": "protocol", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 104 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyKibanaConfig.path", "type": "string", + "tags": [], "label": "path", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 105 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 102 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyOutputPermissions", "type": "Interface", + "tags": [], "label": "FullAgentPolicyOutputPermissions", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 63 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.FullAgentPolicyOutputPermissions.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 64 }, - "signature": [ - "any" - ] + "deprecated": false } ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.GenerateServiceTokenResponse", + "type": "Interface", + "tags": [], + "label": "GenerateServiceTokenResponse", + "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 63 + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 13 }, + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.GenerateServiceTokenResponse.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 14 + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.GenerateServiceTokenResponse.value", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 15 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetAgentPoliciesRequest", "type": "Interface", + "tags": [], "label": "GetAgentPoliciesRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentPoliciesRequest.query", "type": "CompoundType", + "tags": [], "label": "query", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 13 - }, "signature": [ { "pluginId": "fleet", @@ -6685,32 +7565,36 @@ "text": "ListWithKuery" }, " & { full?: boolean | undefined; }" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 13 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetAgentPoliciesResponse", "type": "Interface", + "tags": [], "label": "GetAgentPoliciesResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentPoliciesResponse.items", "type": "Array", + "tags": [], "label": "items", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 21 - }, "signature": [ { "pluginId": "fleet", @@ -6720,93 +7604,107 @@ "text": "GetAgentPoliciesResponseItem" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentPoliciesResponse.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentPoliciesResponse.page", "type": "number", + "tags": [], "label": "page", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentPoliciesResponse.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "lineNumber": 24 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetAgentsRequest", "type": "Interface", + "tags": [], "label": "GetAgentsRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentsRequest.query", "type": "Object", + "tags": [], "label": "query", "description": [], + "signature": [ + "{ page: number; perPage: number; kuery?: string | undefined; showInactive: boolean; showUpgradeable?: boolean | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 19 + "lineNumber": 11 }, - "signature": [ - "{ page: number; perPage: number; kuery?: string | undefined; showInactive: boolean; showUpgradeable?: boolean | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetAgentsResponse", "type": "Interface", + "tags": [], "label": "GetAgentsResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentsResponse.list", "type": "Array", + "tags": [], "label": "list", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 29 - }, "signature": [ { "pluginId": "fleet", @@ -6816,160 +7714,184 @@ "text": "Agent" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentsResponse.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 30 - } + "lineNumber": 22 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentsResponse.totalInactive", "type": "number", + "tags": [], "label": "totalInactive", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 31 - } + "lineNumber": 23 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentsResponse.page", "type": "number", + "tags": [], "label": "page", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 32 - } + "lineNumber": 24 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentsResponse.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 33 - } + "lineNumber": 25 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 28 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetAgentStatusRequest", "type": "Interface", + "tags": [], "label": "GetAgentStatusRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 149 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentStatusRequest.query", "type": "Object", + "tags": [], "label": "query", "description": [], + "signature": [ + "{ kuery?: string | undefined; policyId?: string | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 220 + "lineNumber": 150 }, - "signature": [ - "{ kuery?: string | undefined; policyId?: string | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 219 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetAgentStatusResponse", "type": "Interface", + "tags": [], "label": "GetAgentStatusResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 156 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetAgentStatusResponse.results", "type": "Object", + "tags": [], "label": "results", "description": [], + "signature": [ + "{ events: number; total: number; online: number; error: number; offline: number; other: number; updating: number; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 227 + "lineNumber": 157 }, - "signature": [ - "{ events: number; total: number; online: number; error: number; offline: number; other: number; updating: number; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 226 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetCategoriesRequest", "type": "Interface", + "tags": [], "label": "GetCategoriesRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetCategoriesRequest.query", "type": "Object", + "tags": [], "label": "query", "description": [], + "signature": [ + "{ experimental?: boolean | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 18 + "lineNumber": 19 }, - "signature": [ - "{ experimental?: boolean | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetCategoriesResponse", "type": "Interface", + "tags": [], "label": "GetCategoriesResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetCategoriesResponse.response", "type": "Array", + "tags": [], "label": "response", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 24 - }, "signature": [ { "pluginId": "fleet", @@ -6978,32 +7900,36 @@ "section": "def-common.CategorySummaryList", "text": "CategorySummaryList" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 25 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetDataStreamsResponse", "type": "Interface", + "tags": [], "label": "GetDataStreamsResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetDataStreamsResponse.data_streams", "type": "Array", + "tags": [], "label": "data_streams", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts", - "lineNumber": 11 - }, "signature": [ { "pluginId": "fleet", @@ -7013,60 +7939,68 @@ "text": "DataStream" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts", + "lineNumber": 11 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetEnrollmentAPIKeysRequest", "type": "Interface", + "tags": [], "label": "GetEnrollmentAPIKeysRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetEnrollmentAPIKeysRequest.query", "type": "Object", + "tags": [], "label": "query", "description": [], + "signature": [ + "{ page: number; perPage: number; kuery?: string | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", "lineNumber": 11 }, - "signature": [ - "{ page: number; perPage: number; kuery?: string | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetEnrollmentAPIKeysResponse", "type": "Interface", + "tags": [], "label": "GetEnrollmentAPIKeysResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetEnrollmentAPIKeysResponse.list", "type": "Array", + "tags": [], "label": "list", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "fleet", @@ -7076,160 +8010,184 @@ "text": "EnrollmentAPIKey" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetEnrollmentAPIKeysResponse.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetEnrollmentAPIKeysResponse.page", "type": "number", + "tags": [], "label": "page", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetEnrollmentAPIKeysResponse.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", "lineNumber": 22 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetFileRequest", "type": "Interface", + "tags": [], "label": "GetFileRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetFileRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ pkgkey: string; filePath: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 43 + "lineNumber": 44 }, - "signature": [ - "{ pkgkey: string; filePath: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 42 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetFleetStatusResponse", "type": "Interface", + "tags": [], "label": "GetFleetStatusResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetFleetStatusResponse.isReady", "type": "boolean", + "tags": [], "label": "isReady", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetFleetStatusResponse.missing_requirements", "type": "Array", + "tags": [], "label": "missing_requirements", "description": [], + "signature": [ + "(\"fleet_server\" | \"tls_required\" | \"api_keys\" | \"fleet_admin_user\" | \"encrypted_saved_object_encryption_key_required\")[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", "lineNumber": 14 }, - "signature": [ - "(\"tls_required\" | \"api_keys\" | \"fleet_admin_user\" | \"encrypted_saved_object_encryption_key_required\")[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetFullAgentPolicyRequest", "type": "Interface", + "tags": [], "label": "GetFullAgentPolicyRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 72 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetFullAgentPolicyRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ agentPolicyId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "lineNumber": 73 }, - "signature": [ - "{ agentPolicyId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 72 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetFullAgentPolicyResponse", "type": "Interface", + "tags": [], "label": "GetFullAgentPolicyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 78 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetFullAgentPolicyResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 79 - }, "signature": [ { "pluginId": "fleet", @@ -7238,60 +8196,68 @@ "section": "def-common.FullAgentPolicy", "text": "FullAgentPolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 79 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 78 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetInfoRequest", "type": "Interface", + "tags": [], "label": "GetInfoRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetInfoRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ pkgkey: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 50 + "lineNumber": 51 }, - "signature": [ - "{ pkgkey: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 49 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetInfoResponse", "type": "Interface", + "tags": [], "label": "GetInfoResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 56 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetInfoResponse.response", "type": "CompoundType", + "tags": [], "label": "response", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 56 - }, "signature": [ { "pluginId": "fleet", @@ -7300,198 +8266,100 @@ "section": "def-common.PackageInfo", "text": "PackageInfo" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 57 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 55 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetLimitedPackagesResponse", "type": "Interface", + "tags": [], "label": "GetLimitedPackagesResponse", "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.GetLimitedPackagesResponse.response", - "type": "Array", - "label": "response", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 39 - }, - "signature": [ - "string[]" - ] - } - ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 38 + "lineNumber": 39 }, - "initialIsOpen": false - }, - { - "id": "def-common.GetOneAgentEventsRequest", - "type": "Interface", - "label": "GetOneAgentEventsRequest", - "description": [], - "tags": [], + "deprecated": false, "children": [ { + "parentPluginId": "fleet", + "id": "def-common.GetLimitedPackagesResponse.response", + "type": "Array", "tags": [], - "id": "def-common.GetOneAgentEventsRequest.params", - "type": "Object", - "label": "params", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 187 - }, - "signature": [ - "{ agentId: string; }" - ] - }, - { - "tags": [], - "id": "def-common.GetOneAgentEventsRequest.query", - "type": "Object", - "label": "query", + "label": "response", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 190 - }, "signature": [ - "{ page: number; perPage: number; kuery?: string | undefined; }" - ] - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 186 - }, - "initialIsOpen": false - }, - { - "id": "def-common.GetOneAgentEventsResponse", - "type": "Interface", - "label": "GetOneAgentEventsResponse", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.GetOneAgentEventsResponse.list", - "type": "Array", - "label": "list", - "description": [], + "string[]" + ], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 198 + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 40 }, - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentEvent", - "text": "AgentEvent" - }, - "[]" - ] - }, - { - "tags": [], - "id": "def-common.GetOneAgentEventsResponse.total", - "type": "number", - "label": "total", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 199 - } - }, - { - "tags": [], - "id": "def-common.GetOneAgentEventsResponse.page", - "type": "number", - "label": "page", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 200 - } - }, - { - "tags": [], - "id": "def-common.GetOneAgentEventsResponse.perPage", - "type": "number", - "label": "perPage", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 201 - } + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 197 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOneAgentPolicyRequest", "type": "Interface", + "tags": [], "label": "GetOneAgentPolicyRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOneAgentPolicyRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ agentPolicyId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "lineNumber": 28 }, - "signature": [ - "{ agentPolicyId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOneAgentPolicyResponse", "type": "Interface", + "tags": [], "label": "GetOneAgentPolicyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOneAgentPolicyResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 34 - }, "signature": [ { "pluginId": "fleet", @@ -7500,60 +8368,68 @@ "section": "def-common.AgentPolicy", "text": "AgentPolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 34 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 33 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOneAgentRequest", "type": "Interface", + "tags": [], "label": "GetOneAgentRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOneAgentRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ agentId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 37 + "lineNumber": 29 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 36 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOneAgentResponse", "type": "Interface", + "tags": [], "label": "GetOneAgentResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOneAgentResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 43 - }, "signature": [ { "pluginId": "fleet", @@ -7562,60 +8438,68 @@ "section": "def-common.Agent", "text": "Agent" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 35 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 42 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOneEnrollmentAPIKeyRequest", "type": "Interface", + "tags": [], "label": "GetOneEnrollmentAPIKeyRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOneEnrollmentAPIKeyRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ keyId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", "lineNumber": 26 }, - "signature": [ - "{ keyId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOneEnrollmentAPIKeyResponse", "type": "Interface", + "tags": [], "label": "GetOneEnrollmentAPIKeyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOneEnrollmentAPIKeyResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 32 - }, "signature": [ { "pluginId": "fleet", @@ -7624,60 +8508,68 @@ "section": "def-common.EnrollmentAPIKey", "text": "EnrollmentAPIKey" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 32 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOneOutputRequest", "type": "Interface", + "tags": [], "label": "GetOneOutputRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOneOutputRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ outputId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", "lineNumber": 15 }, - "signature": [ - "{ outputId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOneOutputResponse", "type": "Interface", + "tags": [], "label": "GetOneOutputResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOneOutputResponse.item", "type": "CompoundType", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "lineNumber": 11 - }, "signature": [ { "pluginId": "fleet", @@ -7686,60 +8578,68 @@ "section": "def-common.Output", "text": "Output" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 11 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOnePackagePolicyRequest", "type": "Interface", + "tags": [], "label": "GetOnePackagePolicyRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOnePackagePolicyRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ packagePolicyId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "lineNumber": 26 }, - "signature": [ - "{ packagePolicyId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 25 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOnePackagePolicyResponse", "type": "Interface", + "tags": [], "label": "GetOnePackagePolicyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOnePackagePolicyResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 32 - }, "signature": [ { "pluginId": "fleet", @@ -7748,32 +8648,36 @@ "section": "def-common.PackagePolicy", "text": "PackagePolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 32 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetOutputsResponse", "type": "Interface", + "tags": [], "label": "GetOutputsResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOutputsResponse.items", "type": "Array", + "tags": [], "label": "items", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "lineNumber": 37 - }, "signature": [ { "pluginId": "fleet", @@ -7783,93 +8687,107 @@ "text": "Output" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOutputsResponse.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", "lineNumber": 38 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOutputsResponse.page", "type": "number", + "tags": [], "label": "page", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", "lineNumber": 39 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetOutputsResponse.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", "lineNumber": 40 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "lineNumber": 36 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetPackagePoliciesRequest", "type": "Interface", + "tags": [], "label": "GetPackagePoliciesRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetPackagePoliciesRequest.query", "type": "Object", + "tags": [], "label": "query", "description": [], + "signature": [ + "{ page: number; perPage: number; kuery?: string | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "lineNumber": 11 }, - "signature": [ - "{ page: number; perPage: number; kuery?: string | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetPackagePoliciesResponse", "type": "Interface", + "tags": [], "label": "GetPackagePoliciesResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetPackagePoliciesResponse.items", "type": "Array", + "tags": [], "label": "items", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "fleet", @@ -7879,93 +8797,107 @@ "text": "PackagePolicy" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetPackagePoliciesResponse.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetPackagePoliciesResponse.page", "type": "number", + "tags": [], "label": "page", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetPackagePoliciesResponse.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "lineNumber": 22 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetPackagesRequest", "type": "Interface", + "tags": [], "label": "GetPackagesRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetPackagesRequest.query", "type": "Object", + "tags": [], "label": "query", "description": [], + "signature": [ + "{ category?: string | undefined; experimental?: boolean | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 28 + "lineNumber": 29 }, - "signature": [ - "{ category?: string | undefined; experimental?: boolean | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetPackagesResponse", "type": "Interface", + "tags": [], "label": "GetPackagesResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetPackagesResponse.response", "type": "Array", + "tags": [], "label": "response", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 35 - }, "signature": [ { "pluginId": "fleet", @@ -7983,32 +8915,36 @@ "text": "RegistryPackage" }, ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\">>[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 36 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetSettingsResponse", "type": "Interface", + "tags": [], "label": "GetSettingsResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetSettingsResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "lineNumber": 11 - }, "signature": [ { "pluginId": "fleet", @@ -8017,60 +8953,68 @@ "section": "def-common.Settings", "text": "Settings" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 11 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetStatsRequest", "type": "Interface", + "tags": [], "label": "GetStatsRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetStatsRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ pkgname: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 60 + "lineNumber": 61 }, - "signature": [ - "{ pkgname: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 59 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetStatsResponse", "type": "Interface", + "tags": [], "label": "GetStatsResponse", "description": [], - "tags": [], - "children": [ + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 66 + }, + "deprecated": false, + "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetStatsResponse.response", "type": "Object", + "tags": [], "label": "response", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 66 - }, "signature": [ { "pluginId": "fleet", @@ -8079,192 +9023,222 @@ "section": "def-common.PackageUsageStats", "text": "PackageUsageStats" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 67 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 65 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.IBulkInstallPackageHTTPError", "type": "Interface", + "tags": [], "label": "IBulkInstallPackageHTTPError", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.IBulkInstallPackageHTTPError.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 80 - } + "lineNumber": 81 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.IBulkInstallPackageHTTPError.statusCode", "type": "number", + "tags": [], "label": "statusCode", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 81 - } + "lineNumber": 82 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.IBulkInstallPackageHTTPError.error", "type": "CompoundType", + "tags": [], "label": "error", "description": [], + "signature": [ + "string | Error" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 82 + "lineNumber": 83 }, - "signature": [ - "string | Error" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 79 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.IndexTemplate", "type": "Interface", + "tags": [], "label": "IndexTemplate", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 391 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.IndexTemplate.priority", "type": "number", + "tags": [], "label": "priority", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 387 - } + "lineNumber": 392 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.IndexTemplate.index_patterns", "type": "Array", + "tags": [], "label": "index_patterns", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 388 + "lineNumber": 393 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.IndexTemplate.template", "type": "Object", + "tags": [], "label": "template", "description": [], + "signature": [ + "{ settings: any; mappings: any; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 389 + "lineNumber": 394 }, - "signature": [ - "{ settings: any; mappings: any; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.IndexTemplate.data_stream", "type": "Object", + "tags": [], "label": "data_stream", "description": [], + "signature": [ + "{ hidden?: boolean | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 393 + "lineNumber": 398 }, - "signature": [ - "{ hidden?: boolean | undefined; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.IndexTemplate.composed_of", "type": "Array", + "tags": [], "label": "composed_of", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 394 + "lineNumber": 399 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.IndexTemplate._meta", "type": "Uncategorized", + "tags": [], "label": "_meta", "description": [], + "signature": [ + "object" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 395 + "lineNumber": 400 }, - "signature": [ - "object" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 386 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.IndexTemplateMappings", "type": "Interface", + "tags": [], "label": "IndexTemplateMappings", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 384 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.IndexTemplateMappings.properties", "type": "Any", + "tags": [], "label": "properties", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 380 + "lineNumber": 385 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 379 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.Installation", "type": "Interface", + "tags": [], "label": "Installation", + "description": [], "signature": [ { "pluginId": "fleet", @@ -8276,19 +9250,19 @@ " extends ", "SavedObjectAttributes" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 339 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Installation.installed_kibana", "type": "Array", + "tags": [], "label": "installed_kibana", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 335 - }, "signature": [ { "pluginId": "fleet", @@ -8298,18 +9272,20 @@ "text": "KibanaAssetReference" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 340 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Installation.installed_es", "type": "Array", + "tags": [], "label": "installed_es", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 336 - }, "signature": [ { "pluginId": "fleet", @@ -8319,18 +9295,20 @@ "text": "EsAssetReference" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 341 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Installation.package_assets", "type": "Array", + "tags": [], "label": "package_assets", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 337 - }, "signature": [ { "pluginId": "fleet", @@ -8340,54 +9318,62 @@ "text": "PackageAssetReference" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 342 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Installation.es_index_patterns", "type": "Object", + "tags": [], "label": "es_index_patterns", "description": [], + "signature": [ + "Record" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 338 + "lineNumber": 343 }, - "signature": [ - "Record" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Installation.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 339 - } + "lineNumber": 344 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Installation.version", "type": "string", + "tags": [], "label": "version", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 340 - } + "lineNumber": 345 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Installation.install_status", "type": "CompoundType", + "tags": [], "label": "install_status", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 341 - }, "signature": [ { "pluginId": "fleet", @@ -8396,40 +9382,46 @@ "section": "def-common.EpmPackageInstallStatus", "text": "EpmPackageInstallStatus" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 346 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Installation.install_version", "type": "string", + "tags": [], "label": "install_version", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 342 - } + "lineNumber": 347 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Installation.install_started_at", "type": "string", + "tags": [], "label": "install_started_at", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 343 - } + "lineNumber": 348 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Installation.install_source", "type": "CompoundType", + "tags": [], "label": "install_source", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 344 - }, "signature": [ { "pluginId": "fleet", @@ -8438,60 +9430,68 @@ "section": "def-common.InstallSource", "text": "InstallSource" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 349 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 334 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InstallPackageRequest", "type": "Interface", + "tags": [], "label": "InstallPackageRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 70 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.InstallPackageRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ pkgkey: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 70 + "lineNumber": 71 }, - "signature": [ - "{ pkgkey: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 69 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InstallPackageResponse", "type": "Interface", + "tags": [], "label": "InstallPackageResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 76 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.InstallPackageResponse.response", "type": "Array", + "tags": [], "label": "response", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 76 - }, "signature": [ { "pluginId": "fleet", @@ -8501,32 +9501,36 @@ "text": "AssetReference" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 77 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 75 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InstallResult", "type": "Interface", + "tags": [], "label": "InstallResult", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.InstallResult.assets", "type": "Array", + "tags": [], "label": "assets", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 86 - }, "signature": [ { "pluginId": "fleet", @@ -8535,62 +9539,110 @@ "section": "def-common.AssetReference", "text": "AssetReference" }, - "[]" - ] + "[] | undefined" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 87 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.InstallResult.status", "type": "CompoundType", + "tags": [], "label": "status", "description": [], + "signature": [ + "\"installed\" | \"already_installed\" | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 87 + "lineNumber": 88 + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.InstallResult.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | undefined" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 89 }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.InstallResult.installType", + "type": "CompoundType", + "tags": [], + "label": "installType", + "description": [], "signature": [ - "\"installed\" | \"already_installed\"" - ] + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstallType", + "text": "InstallType" + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 90 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 85 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InstallScriptRequest", "type": "Interface", + "tags": [], "label": "InstallScriptRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/install_script.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.InstallScriptRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ osType: \"macos\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/install_script.ts", "lineNumber": 9 }, - "signature": [ - "{ osType: \"macos\"; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/install_script.ts", - "lineNumber": 8 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ListResult", "type": "Interface", + "tags": [], "label": "ListResult", + "description": [], "signature": [ { "pluginId": "fleet", @@ -8601,67 +9653,77 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ListResult.items", "type": "Array", + "tags": [], "label": "items", "description": [], + "signature": [ + "T[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "lineNumber": 19 }, - "signature": [ - "T[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ListResult.total", "type": "number", + "tags": [], "label": "total", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ListResult.page", "type": "number", + "tags": [], "label": "page", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ListResult.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "lineNumber": 22 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ListWithKuery", "type": "Interface", + "tags": [], "label": "ListWithKuery", + "description": [], "signature": [ { "pluginId": "fleet", @@ -8679,128 +9741,144 @@ "text": "HttpFetchQuery" } ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ListWithKuery.page", "type": "number", + "tags": [], "label": "page", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "lineNumber": 11 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ListWithKuery.perPage", "type": "number", + "tags": [], "label": "perPage", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "lineNumber": 12 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ListWithKuery.sortField", "type": "string", + "tags": [], "label": "sortField", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "lineNumber": 13 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ListWithKuery.sortOrder", "type": "CompoundType", + "tags": [], "label": "sortOrder", "description": [], + "signature": [ + "\"asc\" | \"desc\" | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "lineNumber": 14 }, - "signature": [ - "\"asc\" | \"desc\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ListWithKuery.kuery", "type": "string", + "tags": [], "label": "kuery", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "lineNumber": 15 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.MessageResponse", "type": "Interface", + "tags": [], "label": "MessageResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 109 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.MessageResponse.response", "type": "string", + "tags": [], "label": "response", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 107 - } + "lineNumber": 110 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 106 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.NewAgentAction", "type": "Interface", + "tags": [], "label": "NewAgentAction", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentAction.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 42 - }, "signature": [ { "pluginId": "fleet", @@ -8809,528 +9887,425 @@ "section": "def-common.AgentActionType", "text": "AgentActionType" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 42 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentAction.data", "type": "Any", + "tags": [], "label": "data", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 43 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentAction.sent_at", "type": "string", + "tags": [], "label": "sent_at", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 44 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 41 - }, "initialIsOpen": false }, { - "id": "def-common.NewAgentEvent", + "parentPluginId": "fleet", + "id": "def-common.NewAgentPolicy", "type": "Interface", - "label": "NewAgentEvent", - "description": [], "tags": [], + "label": "NewAgentPolicy", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", + "id": "def-common.NewAgentPolicy.name", + "type": "string", "tags": [], - "id": "def-common.NewAgentEvent.type", - "type": "CompoundType", - "label": "type", + "label": "name", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 97 + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 17 }, - "signature": [ - "\"STATE\" | \"ERROR\" | \"ACTION_RESULT\" | \"ACTION\"" - ] + "deprecated": false }, { + "parentPluginId": "fleet", + "id": "def-common.NewAgentPolicy.namespace", + "type": "string", "tags": [], - "id": "def-common.NewAgentEvent.subtype", - "type": "CompoundType", - "label": "subtype", + "label": "namespace", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 98 + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 18 }, - "signature": [ - "\"RUNNING\" | \"STARTING\" | \"IN_PROGRESS\" | \"CONFIG\" | \"FAILED\" | \"STOPPING\" | \"STOPPED\" | \"DEGRADED\" | \"UPDATING\" | \"DATA_DUMP\" | \"ACKNOWLEDGED\" | \"UNKNOWN\"" - ] + "deprecated": false }, { - "tags": [], - "id": "def-common.NewAgentEvent.timestamp", + "parentPluginId": "fleet", + "id": "def-common.NewAgentPolicy.description", "type": "string", - "label": "timestamp", + "tags": [], + "label": "description", "description": [], + "signature": [ + "string | undefined" + ], "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 113 - } + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 19 + }, + "deprecated": false }, { + "parentPluginId": "fleet", + "id": "def-common.NewAgentPolicy.is_default", + "type": "CompoundType", "tags": [], - "id": "def-common.NewAgentEvent.message", - "type": "string", - "label": "message", + "label": "is_default", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 114 - } + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 20 + }, + "deprecated": false }, { + "parentPluginId": "fleet", + "id": "def-common.NewAgentPolicy.is_default_fleet_server", + "type": "CompoundType", "tags": [], - "id": "def-common.NewAgentEvent.payload", - "type": "Any", - "label": "payload", + "label": "is_default_fleet_server", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 115 + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 21 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], - "id": "def-common.NewAgentEvent.agent_id", - "type": "string", - "label": "agent_id", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 116 - } - }, - { - "tags": [], - "id": "def-common.NewAgentEvent.action_id", - "type": "string", - "label": "action_id", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 117 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.NewAgentEvent.policy_id", - "type": "string", - "label": "policy_id", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 118 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.NewAgentEvent.stream_id", - "type": "string", - "label": "stream_id", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 119 - }, - "signature": [ - "string | undefined" - ] - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 96 - }, - "initialIsOpen": false - }, - { - "id": "def-common.NewAgentPolicy", - "type": "Interface", - "label": "NewAgentPolicy", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.NewAgentPolicy.name", - "type": "string", - "label": "name", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 17 - } - }, - { - "tags": [], - "id": "def-common.NewAgentPolicy.namespace", - "type": "string", - "label": "namespace", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 18 - } - }, - { - "tags": [], - "id": "def-common.NewAgentPolicy.description", - "type": "string", - "label": "description", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 19 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.NewAgentPolicy.is_default", + "parentPluginId": "fleet", + "id": "def-common.NewAgentPolicy.is_managed", "type": "CompoundType", - "label": "is_default", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 20 - }, - "signature": [ - "boolean | undefined" - ] - }, - { "tags": [], - "id": "def-common.NewAgentPolicy.is_default_fleet_server", - "type": "CompoundType", - "label": "is_default_fleet_server", + "label": "is_managed", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 21 - }, "signature": [ "boolean | undefined" - ] - }, - { - "tags": [], - "id": "def-common.NewAgentPolicy.is_managed", - "type": "CompoundType", - "label": "is_managed", - "description": [], + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 22 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentPolicy.monitoring_enabled", "type": "Array", + "tags": [], "label": "monitoring_enabled", "description": [], + "signature": [ + "(\"metrics\" | \"logs\")[] | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 23 }, - "signature": [ - "(\"metrics\" | \"logs\")[] | undefined" - ] + "deprecated": false }, { + "parentPluginId": "fleet", + "id": "def-common.NewAgentPolicy.is_preconfigured", + "type": "CompoundType", "tags": [], - "id": "def-common.NewAgentPolicy.preconfiguration_id", - "type": "string", - "label": "preconfiguration_id", + "label": "is_preconfigured", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 24 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.NewOutput", "type": "Interface", + "tags": [], "label": "NewOutput", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewOutput.is_default", "type": "boolean", + "tags": [], "label": "is_default", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewOutput.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewOutput.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"elasticsearch\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", "lineNumber": 16 }, - "signature": [ - "\"elasticsearch\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewOutput.hosts", "type": "Array", + "tags": [], "label": "hosts", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", "lineNumber": 17 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewOutput.ca_sha256", "type": "string", + "tags": [], "label": "ca_sha256", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", "lineNumber": 18 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewOutput.api_key", "type": "string", - "label": "api_key", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 19 - }, - "signature": [ - "string | undefined" - ] - }, - { "tags": [], - "id": "def-common.NewOutput.fleet_enroll_username", - "type": "string", - "label": "fleet_enroll_username", + "label": "api_key", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 20 - }, "signature": [ "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.NewOutput.fleet_enroll_password", - "type": "string", - "label": "fleet_enroll_password", - "description": [], + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 21 + "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewOutput.config", "type": "Object", + "tags": [], "label": "config", "description": [], + "signature": [ + "Record | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 22 + "lineNumber": 20 }, - "signature": [ - "Record | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewOutput.config_yaml", "type": "string", + "tags": [], "label": "config_yaml", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 23 + "lineNumber": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicy", "type": "Interface", + "tags": [], "label": "NewPackagePolicy", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicy.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 50 - } + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicy.description", "type": "string", + "tags": [], "label": "description", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 51 + "lineNumber": 52 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicy.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 52 - } + "lineNumber": 53 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicy.enabled", "type": "boolean", + "tags": [], "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 53 - } - }, + "lineNumber": 54 + }, + "deprecated": false + }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicy.policy_id", "type": "string", + "tags": [], "label": "policy_id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 54 - } + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicy.output_id", "type": "string", + "tags": [], "label": "output_id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 55 - } + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicy.package", "type": "Object", + "tags": [], "label": "package", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 56 - }, "signature": [ { "pluginId": "fleet", @@ -9340,18 +10315,20 @@ "text": "PackagePolicyPackage" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 57 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicy.inputs", "type": "Array", + "tags": [], "label": "inputs", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 57 - }, "signature": [ { "pluginId": "fleet", @@ -9361,54 +10338,62 @@ "text": "NewPackagePolicyInput" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 58 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 49 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInput", "type": "Interface", + "tags": [], "label": "NewPackagePolicyInput", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInput.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 37 - } + "lineNumber": 38 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInput.enabled", "type": "boolean", + "tags": [], "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 38 - } + "lineNumber": 39 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInput.vars", "type": "Object", + "tags": [], "label": "vars", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 39 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 40 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInput.config", "type": "Object", + "tags": [], "label": "config", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 40 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 41 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInput.streams", "type": "Array", + "tags": [], "label": "streams", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 41 - }, "signature": [ { "pluginId": "fleet", @@ -9462,57 +10451,65 @@ "text": "NewPackagePolicyInputStream" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 42 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 36 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInputStream", "type": "Interface", + "tags": [], "label": "NewPackagePolicyInputStream", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInputStream.enabled", "type": "boolean", + "tags": [], "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 22 - } + "lineNumber": 23 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInputStream.data_stream", "type": "Object", + "tags": [], "label": "data_stream", "description": [], + "signature": [ + "{ dataset: string; type: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 23 + "lineNumber": 24 }, - "signature": [ - "{ dataset: string; type: string; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInputStream.vars", "type": "Object", + "tags": [], "label": "vars", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 27 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 28 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInputStream.config", "type": "Object", + "tags": [], "label": "config", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 28 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 29 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackagePolicy", "type": "Interface", + "tags": [], "label": "PackagePolicy", + "description": [], "signature": [ { "pluginId": "fleet", @@ -9576,30 +10579,32 @@ }, ", \"enabled\" | \"description\" | \"name\" | \"package\" | \"namespace\" | \"policy_id\" | \"output_id\">" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicy.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 65 - } + "lineNumber": 66 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicy.inputs", "type": "Array", + "tags": [], "label": "inputs", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 66 - }, "signature": [ { "pluginId": "fleet", @@ -9609,130 +10614,168 @@ "text": "PackagePolicyInput" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 67 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicy.version", "type": "string", + "tags": [], "label": "version", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 67 + "lineNumber": 68 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicy.revision", "type": "number", + "tags": [], "label": "revision", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 68 - } + "lineNumber": 69 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicy.updated_at", "type": "string", + "tags": [], "label": "updated_at", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 69 - } + "lineNumber": 70 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicy.updated_by", "type": "string", + "tags": [], "label": "updated_by", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 70 - } + "lineNumber": 71 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicy.created_at", "type": "string", + "tags": [], "label": "created_at", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 71 - } + "lineNumber": 72 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicy.created_by", "type": "string", + "tags": [], "label": "created_by", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 72 - } + "lineNumber": 73 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 64 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackagePolicyConfigRecordEntry", "type": "Interface", + "tags": [], "label": "PackagePolicyConfigRecordEntry", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicyConfigRecordEntry.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "lineNumber": 15 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicyConfigRecordEntry.value", "type": "Any", + "tags": [], "label": "value", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "lineNumber": 16 }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackagePolicyConfigRecordEntry.frozen", + "type": "CompoundType", + "tags": [], + "label": "frozen", + "description": [], "signature": [ - "any" - ] + "boolean | undefined" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 17 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackagePolicyInput", "type": "Interface", + "tags": [], "label": "PackagePolicyInput", + "description": [], "signature": [ { "pluginId": "fleet", @@ -9751,19 +10794,19 @@ }, ", \"type\" | \"enabled\" | \"config\" | \"vars\">" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicyInput.streams", "type": "Array", + "tags": [], "label": "streams", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 45 - }, "signature": [ { "pluginId": "fleet", @@ -9773,33 +10816,39 @@ "text": "PackagePolicyInputStream" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 46 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicyInput.compiled_input", "type": "Any", + "tags": [], "label": "compiled_input", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 46 + "lineNumber": 47 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackagePolicyInputStream", "type": "Interface", + "tags": [], "label": "PackagePolicyInputStream", + "description": [], "signature": [ { "pluginId": "fleet", @@ -9817,297 +10866,341 @@ "text": "NewPackagePolicyInputStream" } ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicyInputStream.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 32 - } + "lineNumber": 33 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicyInputStream.compiled_stream", "type": "Any", + "tags": [], "label": "compiled_stream", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 33 + "lineNumber": 34 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackagePolicyPackage", "type": "Interface", + "tags": [], "label": "PackagePolicyPackage", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicyPackage.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "lineNumber": 9 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicyPackage.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "lineNumber": 10 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicyPackage.version", "type": "string", + "tags": [], "label": "version", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "lineNumber": 11 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 8 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageSpecIcon", "type": "Interface", + "tags": [], "label": "PackageSpecIcon", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecIcon.src", "type": "string", + "tags": [], "label": "src", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 61 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecIcon.title", "type": "string", + "tags": [], "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 62 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecIcon.size", "type": "string", + "tags": [], "label": "size", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 63 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecIcon.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 64 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "lineNumber": 60 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest", "type": "Interface", + "tags": [], "label": "PackageSpecManifest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.format_version", "type": "string", + "tags": [], "label": "format_version", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.description", "type": "string", + "tags": [], "label": "description", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.version", "type": "string", + "tags": [], "label": "version", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.license", "type": "string", + "tags": [], "label": "license", "description": [], + "signature": [ + "\"basic\" | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 17 }, - "signature": [ - "\"basic\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"integration\" | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 18 }, - "signature": [ - "\"integration\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.release", "type": "CompoundType", + "tags": [], "label": "release", "description": [], + "signature": [ + "\"experimental\" | \"beta\" | \"ga\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 19 }, - "signature": [ - "\"experimental\" | \"beta\" | \"ga\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.categories", "type": "Array", + "tags": [], "label": "categories", "description": [], + "signature": [ + "(\"custom\" | \"security\" | \"monitoring\" | \"network\" | \"cloud\" | \"kubernetes\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"languages\" | \"message_queue\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | undefined)[] | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 20 }, - "signature": [ - "(\"custom\" | \"security\" | \"monitoring\" | \"cloud\" | \"network\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | undefined)[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.conditions", "type": "Object", + "tags": [], "label": "conditions", "description": [], + "signature": [ + "Record<\"kibana\", { version: string; }> | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 21 }, - "signature": [ - "Record<\"kibana\", { version: string; }> | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.icons", "type": "Array", + "tags": [], "label": "icons", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "lineNumber": 22 - }, "signature": [ { "pluginId": "fleet", @@ -10117,18 +11210,20 @@ "text": "PackageSpecIcon" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 22 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.screenshots", "type": "Array", + "tags": [], "label": "screenshots", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "lineNumber": 23 - }, "signature": [ { "pluginId": "fleet", @@ -10138,18 +11233,20 @@ "text": "PackageSpecScreenshot" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 23 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.policy_templates", "type": "Array", + "tags": [], "label": "policy_templates", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "lineNumber": 24 - }, "signature": [ { "pluginId": "fleet", @@ -10159,629 +11256,422 @@ "text": "RegistryPolicyTemplate" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 24 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.owner", "type": "Object", + "tags": [], "label": "owner", "description": [], + "signature": [ + "{ github: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 25 }, - "signature": [ - "{ github: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "lineNumber": 11 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageSpecScreenshot", "type": "Interface", + "tags": [], "label": "PackageSpecScreenshot", "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.PackageSpecScreenshot.src", - "type": "string", - "label": "src", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "lineNumber": 68 - } - }, - { - "tags": [], - "id": "def-common.PackageSpecScreenshot.title", - "type": "string", - "label": "title", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "lineNumber": 69 - } - }, - { - "tags": [], - "id": "def-common.PackageSpecScreenshot.size", - "type": "string", - "label": "size", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "lineNumber": 70 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.PackageSpecScreenshot.type", - "type": "string", - "label": "type", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "lineNumber": 71 - }, - "signature": [ - "string | undefined" - ] - } - ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 67 }, - "initialIsOpen": false - }, - { - "id": "def-common.PackageUsageStats", - "type": "Interface", - "label": "PackageUsageStats", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.PackageUsageStats.agent_policy_count", - "type": "number", - "label": "agent_policy_count", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 348 - } - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 347 - }, - "initialIsOpen": false - }, - { - "id": "def-common.PostAgentAcksRequest", - "type": "Interface", - "label": "PostAgentAcksRequest", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.PostAgentAcksRequest.body", - "type": "Object", - "label": "body", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 80 - }, - "signature": [ - "{ events: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentEvent", - "text": "AgentEvent" - }, - "[]; }" - ] - }, - { - "tags": [], - "id": "def-common.PostAgentAcksRequest.params", - "type": "Object", - "label": "params", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 83 - }, - "signature": [ - "{ agentId: string; }" - ] - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 79 - }, - "initialIsOpen": false - }, - { - "id": "def-common.PostAgentAcksResponse", - "type": "Interface", - "label": "PostAgentAcksResponse", - "description": [], - "tags": [], + "deprecated": false, "children": [ { - "tags": [], - "id": "def-common.PostAgentAcksResponse.action", + "parentPluginId": "fleet", + "id": "def-common.PackageSpecScreenshot.src", "type": "string", - "label": "action", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 89 - } - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 88 - }, - "initialIsOpen": false - }, - { - "id": "def-common.PostAgentCheckinRequest", - "type": "Interface", - "label": "PostAgentCheckinRequest", - "description": [], - "tags": [], - "children": [ - { "tags": [], - "id": "def-common.PostAgentCheckinRequest.params", - "type": "Object", - "label": "params", + "label": "src", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 47 + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 68 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false }, { - "tags": [], - "id": "def-common.PostAgentCheckinRequest.body", - "type": "Object", - "label": "body", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 50 - }, - "signature": [ - "{ status?: \"online\" | \"error\" | \"degraded\" | undefined; local_metadata?: Record | undefined; events?: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewAgentEvent", - "text": "NewAgentEvent" - }, - "[] | undefined; }" - ] - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 46 - }, - "initialIsOpen": false - }, - { - "id": "def-common.PostAgentCheckinResponse", - "type": "Interface", - "label": "PostAgentCheckinResponse", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.PostAgentCheckinResponse.action", + "parentPluginId": "fleet", + "id": "def-common.PackageSpecScreenshot.title", "type": "string", - "label": "action", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 58 - } - }, - { "tags": [], - "id": "def-common.PostAgentCheckinResponse.actions", - "type": "Array", - "label": "actions", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 60 - }, - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentAction", - "text": "AgentAction" - }, - "[]" - ] - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 57 - }, - "initialIsOpen": false - }, - { - "id": "def-common.PostAgentEnrollRequest", - "type": "Interface", - "label": "PostAgentEnrollRequest", - "description": [], - "tags": [], - "children": [ + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 69 + }, + "deprecated": false + }, { + "parentPluginId": "fleet", + "id": "def-common.PackageSpecScreenshot.size", + "type": "string", "tags": [], - "id": "def-common.PostAgentEnrollRequest.body", - "type": "Object", - "label": "body", + "label": "size", "description": [], + "signature": [ + "string | undefined" + ], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 64 + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 70 }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackageSpecScreenshot.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], "signature": [ - "{ type: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentType", - "text": "AgentType" - }, - "; metadata: { local: Record; user_provided: Record; }; }" - ] + "string | undefined" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 71 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 63 - }, "initialIsOpen": false }, { - "id": "def-common.PostAgentEnrollResponse", + "parentPluginId": "fleet", + "id": "def-common.PackageUsageStats", "type": "Interface", - "label": "PostAgentEnrollResponse", - "description": [], "tags": [], + "label": "PackageUsageStats", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 352 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", + "id": "def-common.PackageUsageStats.agent_policy_count", + "type": "number", "tags": [], - "id": "def-common.PostAgentEnrollResponse.action", - "type": "string", - "label": "action", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 74 - } - }, - { - "tags": [], - "id": "def-common.PostAgentEnrollResponse.item", - "type": "CompoundType", - "label": "item", + "label": "agent_policy_count", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 76 + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 353 }, - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Agent", - "text": "Agent" - }, - " & { status: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentStatus", - "text": "AgentStatus" - }, - "; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 73 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostAgentUnenrollRequest", "type": "Interface", + "tags": [], "label": "PostAgentUnenrollRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostAgentUnenrollRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ agentId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 106 + "lineNumber": 52 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostAgentUnenrollRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ force?: boolean | undefined; revoke?: boolean | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 109 + "lineNumber": 55 }, - "signature": [ - "{ force?: boolean | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 105 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostAgentUnenrollResponse", "type": "Interface", + "tags": [], "label": "PostAgentUnenrollResponse", "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 115 + "lineNumber": 62 }, + "deprecated": false, + "children": [], "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostAgentUpgradeRequest", "type": "Interface", + "tags": [], "label": "PostAgentUpgradeRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostAgentUpgradeRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ agentId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 133 + "lineNumber": 81 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostAgentUpgradeRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ source_uri?: string | undefined; version: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 136 + "lineNumber": 84 }, - "signature": [ - "{ source_uri?: string | undefined; version: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 132 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostAgentUpgradeResponse", "type": "Interface", + "tags": [], "label": "PostAgentUpgradeResponse", "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 159 + "lineNumber": 107 }, + "deprecated": false, + "children": [], "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostBulkAgentReassignRequest", "type": "Interface", + "tags": [], "label": "PostBulkAgentReassignRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 119 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostBulkAgentReassignRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ policy_id: string; agents: string | string[]; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 172 + "lineNumber": 120 }, - "signature": [ - "{ policy_id: string; agents: string | string[]; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 171 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostBulkAgentUnenrollRequest", "type": "Interface", + "tags": [], "label": "PostBulkAgentUnenrollRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostBulkAgentUnenrollRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ agents: string | string[]; force?: boolean | undefined; revoke?: boolean | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 118 + "lineNumber": 65 }, - "signature": [ - "{ agents: string | string[]; force?: boolean | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 117 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostBulkAgentUpgradeRequest", "type": "Interface", + "tags": [], "label": "PostBulkAgentUpgradeRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 90 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostBulkAgentUpgradeRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ agents: string | string[]; source_uri?: string | undefined; version: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 143 + "lineNumber": 91 }, - "signature": [ - "{ agents: string | string[]; source_uri?: string | undefined; version: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 142 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostEnrollmentAPIKeyRequest", "type": "Interface", + "tags": [], "label": "PostEnrollmentAPIKeyRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostEnrollmentAPIKeyRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ name?: string | undefined; policy_id: string; expiration?: string | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", "lineNumber": 46 }, - "signature": [ - "{ name?: string | undefined; policy_id: string; expiration?: string | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 45 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostEnrollmentAPIKeyResponse", "type": "Interface", + "tags": [], "label": "PostEnrollmentAPIKeyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostEnrollmentAPIKeyResponse.action", "type": "string", + "tags": [], "label": "action", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", "lineNumber": 54 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostEnrollmentAPIKeyResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 55 - }, "signature": [ { "pluginId": "fleet", @@ -10790,57 +11680,81 @@ "section": "def-common.EnrollmentAPIKey", "text": "EnrollmentAPIKey" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 55 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostIngestSetupResponse", "type": "Interface", + "tags": [], "label": "PostIngestSetupResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostIngestSetupResponse.isInitialized", "type": "boolean", + "tags": [], "label": "isInitialized", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts", - "lineNumber": 9 - } + "lineNumber": 9 + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PostIngestSetupResponse.nonFatalErrors", + "type": "Array", + "tags": [], + "label": "nonFatalErrors", + "description": [], + "signature": [ + "{ error: Error; }[] | undefined" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts", + "lineNumber": 10 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts", - "lineNumber": 8 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostNewAgentActionRequest", "type": "Interface", + "tags": [], "label": "PostNewAgentActionRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostNewAgentActionRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 93 - }, "signature": [ "{ action: ", { @@ -10851,46 +11765,52 @@ "text": "NewAgentAction" }, "; }" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 39 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostNewAgentActionRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ agentId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 96 + "lineNumber": 42 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 92 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostNewAgentActionResponse", "type": "Interface", + "tags": [], "label": "PostNewAgentActionResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PostNewAgentActionResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 102 - }, "signature": [ { "pluginId": "fleet", @@ -10899,19 +11819,87 @@ "section": "def-common.AgentAction", "text": "AgentAction" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 48 + }, + "deprecated": false } ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PreconfigurationError", + "type": "Interface", + "tags": [], + "label": "PreconfigurationError", + "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 101 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 67 }, + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.PreconfigurationError.package", + "type": "Object", + "tags": [], + "label": "package", + "description": [], + "signature": [ + "{ name: string; version: string; } | undefined" + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 68 + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PreconfigurationError.agentPolicy", + "type": "Object", + "tags": [], + "label": "agentPolicy", + "description": [], + "signature": [ + "{ name: string; } | undefined" + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 69 + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PreconfigurationError.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 70 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PreconfiguredAgentPolicy", "type": "Interface", + "tags": [], "label": "PreconfiguredAgentPolicy", + "description": [], "signature": [ { "pluginId": "fleet", @@ -10928,49 +11916,53 @@ "section": "def-common.NewAgentPolicy", "text": "NewAgentPolicy" }, - ", \"description\" | \"name\" | \"is_default\" | \"is_managed\" | \"is_default_fleet_server\" | \"monitoring_enabled\" | \"preconfiguration_id\">" + ", \"description\" | \"name\" | \"is_default\" | \"is_default_fleet_server\" | \"is_managed\" | \"monitoring_enabled\" | \"is_preconfigured\">" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PreconfiguredAgentPolicy.id", "type": "CompoundType", + "tags": [], "label": "id", "description": [], + "signature": [ + "React.ReactText" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", "lineNumber": 20 }, - "signature": [ - "React.ReactText" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PreconfiguredAgentPolicy.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", "lineNumber": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PreconfiguredAgentPolicy.package_policies", "type": "Array", + "tags": [], "label": "package_policies", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "lineNumber": 22 - }, "signature": [ "(Partial> & { name: string; package: Partial<", + ", \"enabled\" | \"description\" | \"name\" | \"namespace\" | \"policy_id\" | \"output_id\">> & { name: string; package: Partial<", { "pluginId": "fleet", "scope": "common", @@ -10988,7 +11980,7 @@ "section": "def-common.PackagePolicyPackage", "text": "PackagePolicyPackage" }, - ">; inputs?: ", + "> & { name: string; }; inputs?: ", { "pluginId": "fleet", "scope": "common", @@ -10997,175 +11989,147 @@ "text": "InputsOverride" }, "[] | undefined; })[]" - ] - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "lineNumber": 19 - }, - "initialIsOpen": false - }, - { - "id": "def-common.PreconfiguredPackage", - "type": "Interface", - "label": "PreconfiguredPackage", - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PreconfiguredPackage", - "text": "PreconfiguredPackage" - }, - " extends Pick<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyPackage", - "text": "PackagePolicyPackage" - }, - ", \"name\" | \"version\">" - ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.PreconfiguredPackage.force", - "type": "CompoundType", - "label": "force", - "description": [], + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "lineNumber": 32 + "lineNumber": 22 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "lineNumber": 31 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PutAgentReassignRequest", "type": "Interface", + "tags": [], "label": "PutAgentReassignRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 109 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PutAgentReassignRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ agentId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 162 + "lineNumber": 110 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PutAgentReassignRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ policy_id: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 165 + "lineNumber": 113 }, - "signature": [ - "{ policy_id: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 161 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PutAgentReassignResponse", "type": "Interface", + "tags": [], "label": "PutAgentReassignResponse", "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 169 + "lineNumber": 117 }, + "deprecated": false, + "children": [], "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PutOutputRequest", "type": "Interface", + "tags": [], "label": "PutOutputRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PutOutputRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ outputId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", "lineNumber": 21 }, - "signature": [ - "{ outputId: string; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PutOutputRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ hosts?: string[] | undefined; ca_sha256?: string | undefined; config?: Record | undefined; config_yaml?: string | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", "lineNumber": 24 }, - "signature": [ - "{ hosts?: string[] | undefined; ca_sha256?: string | undefined; config?: Record | undefined; config_yaml?: string | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PutOutputResponse", "type": "Interface", + "tags": [], "label": "PutOutputResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PutOutputResponse.item", "type": "CompoundType", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "lineNumber": 33 - }, "signature": [ { "pluginId": "fleet", @@ -11174,32 +12138,36 @@ "section": "def-common.Output", "text": "Output" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 33 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "lineNumber": 32 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PutSettingsRequest", "type": "Interface", + "tags": [], "label": "PutSettingsRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PutSettingsRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "lineNumber": 15 - }, "signature": [ "Partial>" - ] + ", \"has_seen_add_data_notice\" | \"has_seen_fleet_migration_notice\" | \"fleet_server_hosts\">>" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 15 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PutSettingsResponse", "type": "Interface", + "tags": [], "label": "PutSettingsResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PutSettingsResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "fleet", @@ -11244,104 +12216,120 @@ "section": "def-common.Settings", "text": "Settings" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 19 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream", "type": "Interface", + "tags": [], "label": "RegistryDataStream", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 266 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.type", "type": "string", + "tags": [], "label": "[RegistryDataStreamKeys.type]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 262 - } + "lineNumber": 267 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.ilm_policy", "type": "string", + "tags": [], "label": "[RegistryDataStreamKeys.ilm_policy]", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 263 + "lineNumber": 268 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.hidden", "type": "CompoundType", + "tags": [], "label": "[RegistryDataStreamKeys.hidden]", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 264 + "lineNumber": 269 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.dataset", "type": "string", + "tags": [], "label": "[RegistryDataStreamKeys.dataset]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 265 - } + "lineNumber": 270 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.title", "type": "string", + "tags": [], "label": "[RegistryDataStreamKeys.title]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 266 - } + "lineNumber": 271 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.release", "type": "string", + "tags": [], "label": "[RegistryDataStreamKeys.release]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 267 - } + "lineNumber": 272 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.streams", "type": "Array", + "tags": [], "label": "[RegistryDataStreamKeys.streams]", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 268 - }, "signature": [ { "pluginId": "fleet", @@ -11351,51 +12339,59 @@ "text": "RegistryStream" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 273 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.package", "type": "string", + "tags": [], "label": "[RegistryDataStreamKeys.package]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 269 - } + "lineNumber": 274 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.path", "type": "string", + "tags": [], "label": "[RegistryDataStreamKeys.path]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 270 - } + "lineNumber": 275 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.ingest_pipeline", "type": "string", + "tags": [], "label": "[RegistryDataStreamKeys.ingest_pipeline]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 271 - } + "lineNumber": 276 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.elasticsearch", "type": "Object", + "tags": [], "label": "[RegistryDataStreamKeys.elasticsearch]", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 272 - }, "signature": [ { "pluginId": "fleet", @@ -11405,227 +12401,261 @@ "text": "RegistryElasticsearch" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 277 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.dataset_is_prefix", "type": "CompoundType", + "tags": [], "label": "[RegistryDataStreamKeys.dataset_is_prefix]", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 273 + "lineNumber": 278 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 261 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryElasticsearch", "type": "Interface", + "tags": [], "label": "RegistryElasticsearch", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 281 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryElasticsearch.index_template.settings", "type": "Uncategorized", + "tags": [], "label": "'index_template.settings'", "description": [], + "signature": [ + "object | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 277 + "lineNumber": 282 }, - "signature": [ - "object | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryElasticsearch.index_template.mappings", "type": "Uncategorized", + "tags": [], "label": "'index_template.mappings'", "description": [], + "signature": [ + "object | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 278 + "lineNumber": 283 }, - "signature": [ - "object | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 276 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryImage", "type": "Interface", + "tags": [], "label": "RegistryImage", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 121 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryImage.src", "type": "string", + "tags": [], "label": "src", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 117 - } + "lineNumber": 122 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryImage.path", "type": "string", + "tags": [], "label": "path", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 118 - } + "lineNumber": 123 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryImage.title", "type": "string", + "tags": [], "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 119 + "lineNumber": 124 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryImage.size", "type": "string", + "tags": [], "label": "size", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 120 + "lineNumber": 125 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryImage.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 121 + "lineNumber": 126 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 116 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryInput", "type": "Interface", + "tags": [], "label": "RegistryInput", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 154 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryInput.RegistryInputKeys.type", "type": "string", + "tags": [], "label": "[RegistryInputKeys.type]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 150 - } + "lineNumber": 155 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryInput.RegistryInputKeys.title", "type": "string", + "tags": [], "label": "[RegistryInputKeys.title]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 151 - } + "lineNumber": 156 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryInput.RegistryInputKeys.description", "type": "string", + "tags": [], "label": "[RegistryInputKeys.description]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 152 - } + "lineNumber": 157 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryInput.RegistryInputKeys.template_path", "type": "string", + "tags": [], "label": "[RegistryInputKeys.template_path]", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 153 + "lineNumber": 158 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryInput.RegistryInputKeys.condition", "type": "string", + "tags": [], "label": "[RegistryInputKeys.condition]", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 154 + "lineNumber": 159 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryInput.RegistryInputKeys.vars", "type": "Array", + "tags": [], "label": "[RegistryInputKeys.vars]", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 155 - }, "signature": [ { "pluginId": "fleet", @@ -11635,65 +12665,75 @@ "text": "RegistryVarsEntry" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 160 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 149 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryPolicyTemplate", "type": "Interface", + "tags": [], "label": "RegistryPolicyTemplate", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 137 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.name", "type": "string", + "tags": [], "label": "[RegistryPolicyTemplateKeys.name]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 133 - } + "lineNumber": 138 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.title", "type": "string", + "tags": [], "label": "[RegistryPolicyTemplateKeys.title]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 134 - } + "lineNumber": 139 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.description", "type": "string", + "tags": [], "label": "[RegistryPolicyTemplateKeys.description]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 135 - } + "lineNumber": 140 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.inputs", "type": "Array", + "tags": [], "label": "[RegistryPolicyTemplateKeys.inputs]", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 136 - }, "signature": [ { "pluginId": "fleet", @@ -11703,96 +12743,110 @@ "text": "RegistryInput" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 141 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.multiple", "type": "CompoundType", + "tags": [], "label": "[RegistryPolicyTemplateKeys.multiple]", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 137 + "lineNumber": 142 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 132 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryStream", "type": "Interface", + "tags": [], "label": "RegistryStream", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 172 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryStream.RegistryStreamKeys.input", "type": "string", + "tags": [], "label": "[RegistryStreamKeys.input]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 168 - } + "lineNumber": 173 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryStream.RegistryStreamKeys.title", "type": "string", + "tags": [], "label": "[RegistryStreamKeys.title]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 169 - } + "lineNumber": 174 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryStream.RegistryStreamKeys.description", "type": "string", + "tags": [], "label": "[RegistryStreamKeys.description]", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 170 + "lineNumber": 175 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryStream.RegistryStreamKeys.enabled", "type": "CompoundType", + "tags": [], "label": "[RegistryStreamKeys.enabled]", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 171 + "lineNumber": 176 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryStream.RegistryStreamKeys.vars", "type": "Array", + "tags": [], "label": "[RegistryStreamKeys.vars]", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 172 - }, "signature": [ { "pluginId": "fleet", @@ -11802,82 +12856,94 @@ "text": "RegistryVarsEntry" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 177 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryStream.RegistryStreamKeys.template_path", "type": "string", + "tags": [], "label": "[RegistryStreamKeys.template_path]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 173 - } + "lineNumber": 178 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 167 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry", "type": "Interface", + "tags": [], "label": "RegistryVarsEntry", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 302 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.name", "type": "string", + "tags": [], "label": "[RegistryVarsEntryKeys.name]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 298 - } + "lineNumber": 303 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.title", "type": "string", + "tags": [], "label": "[RegistryVarsEntryKeys.title]", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 299 + "lineNumber": 304 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.description", "type": "string", + "tags": [], "label": "[RegistryVarsEntryKeys.description]", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 300 + "lineNumber": 305 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.type", "type": "CompoundType", + "tags": [], "label": "[RegistryVarsEntryKeys.type]", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 301 - }, "signature": [ { "pluginId": "fleet", @@ -11886,114 +12952,132 @@ "section": "def-common.RegistryVarType", "text": "RegistryVarType" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 306 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.required", "type": "CompoundType", + "tags": [], "label": "[RegistryVarsEntryKeys.required]", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 302 + "lineNumber": 307 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.show_user", "type": "CompoundType", + "tags": [], "label": "[RegistryVarsEntryKeys.show_user]", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 303 + "lineNumber": 308 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.multi", "type": "CompoundType", + "tags": [], "label": "[RegistryVarsEntryKeys.multi]", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 304 + "lineNumber": 309 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.default", "type": "CompoundType", + "tags": [], "label": "[RegistryVarsEntryKeys.default]", "description": [], + "signature": [ + "string | string[] | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 305 + "lineNumber": 310 }, - "signature": [ - "string | string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.os", "type": "Object", + "tags": [], "label": "[RegistryVarsEntryKeys.os]", "description": [], + "signature": [ + "{ [key: string]: { default: string | string[]; }; } | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 306 + "lineNumber": 311 }, - "signature": [ - "{ [key: string]: { default: string | string[]; }; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 297 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ServiceRequirements", "type": "Interface", + "tags": [], "label": "ServiceRequirements", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 183 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ServiceRequirements.versions", "type": "string", + "tags": [], "label": "versions", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 179 - } + "lineNumber": 184 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 178 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.Settings", "type": "Interface", + "tags": [], "label": "Settings", + "description": [], "signature": [ { "pluginId": "fleet", @@ -12011,31 +13095,35 @@ "text": "BaseSettings" } ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Settings.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 19 - } + "lineNumber": 17 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.SettingsSOAttributes", "type": "Interface", + "tags": [], "label": "SettingsSOAttributes", + "description": [], "signature": [ { "pluginId": "fleet", @@ -12055,43 +13143,47 @@ ",", "SavedObjectAttributes" ], - "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 22 + "lineNumber": 20 }, + "deprecated": false, + "children": [], "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.TemplateRef", "type": "Interface", + "tags": [], "label": "TemplateRef", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 403 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.TemplateRef.templateName", "type": "string", + "tags": [], "label": "templateName", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 399 - } + "lineNumber": 404 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.TemplateRef.indexTemplate", "type": "Object", + "tags": [], "label": "indexTemplate", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 400 - }, "signature": [ { "pluginId": "fleet", @@ -12100,32 +13192,36 @@ "section": "def-common.IndexTemplate", "text": "IndexTemplate" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 405 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 398 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.UpdateAgentPolicyResponse", "type": "Interface", + "tags": [], "label": "UpdateAgentPolicyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.UpdateAgentPolicyResponse.item", "type": "Object", + "tags": [], "label": "item", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 50 - }, "signature": [ { "pluginId": "fleet", @@ -12134,61 +13230,71 @@ "section": "def-common.AgentPolicy", "text": "AgentPolicy" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 50 + }, + "deprecated": false } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 49 - }, + ], "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.UpdateAgentRequest", "type": "Interface", + "tags": [], "label": "UpdateAgentRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 140 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.UpdateAgentRequest.params", "type": "Object", + "tags": [], "label": "params", "description": [], + "signature": [ + "{ agentId: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 211 + "lineNumber": 141 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.UpdateAgentRequest.body", "type": "Object", + "tags": [], "label": "body", "description": [], + "signature": [ + "{ user_provided_metadata: Record; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 214 + "lineNumber": 144 }, - "signature": [ - "{ user_provided_metadata: Record; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 210 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.UpdatePackagePolicy", "type": "Interface", + "tags": [], "label": "UpdatePackagePolicy", + "description": [], "signature": [ { "pluginId": "fleet", @@ -12206,614 +13312,658 @@ "text": "NewPackagePolicy" } ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.UpdatePackagePolicy.version", "type": "string", + "tags": [], "label": "version", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 61 + "lineNumber": 62 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 60 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "fleet", "id": "def-common.ElasticsearchAssetType", "type": "Enum", - "label": "ElasticsearchAssetType", "tags": [], + "label": "ElasticsearchAssetType", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 71 + "lineNumber": 76 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InstallStatus", "type": "Enum", - "label": "InstallStatus", "tags": [], + "label": "InstallStatus", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 26 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.KibanaAssetType", "type": "Enum", - "label": "KibanaAssetType", "tags": [], + "label": "KibanaAssetType", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 46 + "lineNumber": 51 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.KibanaSavedObjectType", "type": "Enum", - "label": "KibanaSavedObjectType", "tags": [], + "label": "KibanaSavedObjectType", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 60 + "lineNumber": 65 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryDataStreamKeys", "type": "Enum", - "label": "RegistryDataStreamKeys", "tags": [], + "label": "RegistryDataStreamKeys", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 246 + "lineNumber": 251 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryInputKeys", "type": "Enum", - "label": "RegistryInputKeys", "tags": [], + "label": "RegistryInputKeys", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 140 + "lineNumber": 145 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryPolicyTemplateKeys", "type": "Enum", - "label": "RegistryPolicyTemplateKeys", "tags": [], + "label": "RegistryPolicyTemplateKeys", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 124 + "lineNumber": 129 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryStreamKeys", "type": "Enum", - "label": "RegistryStreamKeys", "tags": [], + "label": "RegistryStreamKeys", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 158 + "lineNumber": 163 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntryKeys", "type": "Enum", - "label": "RegistryVarsEntryKeys", "tags": [], + "label": "RegistryVarsEntryKeys", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 282 + "lineNumber": 287 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_ACTION_SAVED_OBJECT_TYPE", "type": "string", + "tags": [], "label": "AGENT_ACTION_SAVED_OBJECT_TYPE", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 12 - }, "signature": [ "\"fleet-agent-actions\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 9 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_ACTIONS_INDEX", "type": "string", + "tags": [], "label": "AGENT_ACTIONS_INDEX", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 30 - }, "signature": [ "\".fleet-actions\"" ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-common.AGENT_EVENT_SAVED_OBJECT_TYPE", - "type": "string", - "label": "AGENT_EVENT_SAVED_OBJECT_TYPE", - "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 11 + "lineNumber": 27 }, - "signature": [ - "\"fleet-agent-events\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_API_ROOT", "type": "string", + "tags": [], "label": "AGENT_POLICY_API_ROOT", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 14 }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_INDEX", "type": "string", + "tags": [], "label": "AGENT_POLICY_INDEX", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 13 - }, "signature": [ "\".fleet-policies\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 9 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS", "type": "number", + "tags": [], "label": "AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 26 - }, "signature": [ "1000" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 23 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL", "type": "number", + "tags": [], "label": "AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 27 - }, "signature": [ "5" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 24 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_SAVED_OBJECT_TYPE", "type": "string", + "tags": [], "label": "AGENT_POLICY_SAVED_OBJECT_TYPE", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 12 - }, "signature": [ "\"ingest-agent-policies\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 8 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLLING_INTERVAL", "type": "number", + "tags": [], "label": "AGENT_POLLING_INTERVAL", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 22 - }, "signature": [ "1000" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 19 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS", "type": "number", + "tags": [], "label": "AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 19 - }, "signature": [ "20000" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 16 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLLING_REQUEST_TIMEOUT_MS", "type": "number", + "tags": [], "label": "AGENT_POLLING_REQUEST_TIMEOUT_MS", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 18 - }, "signature": [ "300000" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 15 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLLING_THRESHOLD_MS", "type": "number", + "tags": [], "label": "AGENT_POLLING_THRESHOLD_MS", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 21 - }, "signature": [ "30000" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 18 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_SAVED_OBJECT_TYPE", "type": "string", + "tags": [], "label": "AGENT_SAVED_OBJECT_TYPE", "description": [], + "signature": [ + "\"fleet-agents\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 8 }, - "signature": [ - "\"fleet-agents\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_TYPE_EPHEMERAL", "type": "string", + "tags": [], "label": "AGENT_TYPE_EPHEMERAL", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 15 - }, "signature": [ "\"EPHEMERAL\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 12 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_TYPE_PERMANENT", "type": "string", + "tags": [], "label": "AGENT_TYPE_PERMANENT", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 14 - }, "signature": [ "\"PERMANENT\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_TYPE_TEMPORARY", "type": "string", + "tags": [], "label": "AGENT_TYPE_TEMPORARY", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 16 - }, "signature": [ "\"TEMPORARY\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 13 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_UPDATE_ACTIONS_INTERVAL_MS", "type": "number", + "tags": [], "label": "AGENT_UPDATE_ACTIONS_INTERVAL_MS", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 24 - }, "signature": [ "5000" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS", "type": "number", + "tags": [], "label": "AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 23 - }, "signature": [ "30000" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentActionSOAttributes", "type": "Type", - "label": "AgentActionSOAttributes", "tags": [], + "label": "AgentActionSOAttributes", "description": [], + "signature": [ + "CommonAgentActionSOAttributes & { agent_id: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 87 }, - "signature": [ - "CommonAgentActionSOAttributes & { agent_id: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentActionType", "type": "Type", - "label": "AgentActionType", "tags": [], + "label": "AgentActionType", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 34 - }, "signature": [ "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 34 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentAssetType", "type": "Type", - "label": "AgentAssetType", "tags": [], + "label": "AgentAssetType", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 40 - }, "signature": [ "{ readonly Input: \"input\"; }" ], - "initialIsOpen": false - }, - { - "id": "def-common.AgentEventSOAttributes", - "type": "Type", - "label": "AgentEventSOAttributes", - "tags": [], - "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 126 + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 45 }, - "signature": [ - "NewAgentEvent" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentPolicyActionSOAttributes", "type": "Type", - "label": "AgentPolicyActionSOAttributes", "tags": [], + "label": "AgentPolicyActionSOAttributes", "description": [], + "signature": [ + "CommonAgentActionSOAttributes & { policy_id: string; policy_revision: number; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 90 }, - "signature": [ - "CommonAgentActionSOAttributes & { policy_id: string; policy_revision: number; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentPolicyActionV7_9", "type": "Type", - "label": "AgentPolicyActionV7_9", "tags": [], + "label": "AgentPolicyActionV7_9", "description": [], + "signature": [ + "Pick & { type: 'CONFIG_CHANGE'; data: { config: FullAgentPolicy;}; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 71 }, - "signature": [ - "Pick & { type: 'CONFIG_CHANGE'; data: { config: FullAgentPolicy;}; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentPolicySOAttributes", "type": "Type", - "label": "AgentPolicySOAttributes", "tags": [], + "label": "AgentPolicySOAttributes", "description": [], + "signature": [ + "{ status: ValueOf<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; updated_by: string; namespace: string; is_default?: boolean | undefined; package_policies: string[] | PackagePolicy[]; is_default_fleet_server?: boolean | undefined; is_managed: boolean; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; is_preconfigured?: boolean | undefined; revision: number; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 37 }, - "signature": [ - "{ status: ValueOf<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; namespace: string; is_default?: boolean | undefined; updated_by: string; revision: number; package_policies: string[] | PackagePolicy[]; is_managed: boolean; is_default_fleet_server?: boolean | undefined; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; preconfiguration_id?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentPolicyStatus", "type": "Type", - "label": "AgentPolicyStatus", "tags": [], + "label": "AgentPolicyStatus", "description": [], + "signature": [ + "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 14 }, - "signature": [ - "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENTS_INDEX", "type": "string", + "tags": [], "label": "AGENTS_INDEX", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 29 - }, "signature": [ "\".fleet-agents\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 26 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentStatus", "type": "Type", - "label": "AgentStatus", "tags": [], + "label": "AgentStatus", "description": [], + "signature": [ + "\"warning\" | \"offline\" | \"online\" | \"error\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 21 }, - "signature": [ - "\"warning\" | \"offline\" | \"online\" | \"error\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentType", "type": "Type", - "label": "AgentType", "tags": [], + "label": "AgentType", "description": [], + "signature": [ + "\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 16 }, - "signature": [ - "\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.API_ROOT", "type": "string", + "tags": [], "label": "API_ROOT", "description": [], + "signature": [ + "\"/api/fleet\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 10 }, - "signature": [ - "\"/api/fleet\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ArchivePackage", "type": "Type", - "label": "ArchivePackage", "tags": [], + "label": "ArchivePackage", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 84 - }, "signature": [ "PackageSpecManifest & Pick" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 89 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AssetReference", "type": "Type", - "label": "AssetReference", "tags": [], + "label": "AssetReference", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 362 - }, "signature": [ { "pluginId": "fleet", @@ -12831,48 +13981,54 @@ "text": "KibanaAssetReference" } ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 367 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ASSETS_SAVED_OBJECT_TYPE", "type": "string", + "tags": [], "label": "ASSETS_SAVED_OBJECT_TYPE", "description": [], + "signature": [ + "\"epm-packages-assets\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", "lineNumber": 9 }, - "signature": [ - "\"epm-packages-assets\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AssetsGroupedByServiceByType", "type": "Type", - "label": "AssetsGroupedByServiceByType", "tags": [], + "label": "AssetsGroupedByServiceByType", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 224 - }, "signature": [ "Record<\"kibana\", Record> & Record<\"elasticsearch\", Record>" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 229 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AssetType", "type": "Type", - "label": "AssetType", "tags": [], + "label": "AssetType", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 41 - }, "signature": [ "\"input\" | ", { @@ -12915,33 +14071,37 @@ "text": "KibanaAssetType" } ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 46 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AssetTypeToParts", "type": "Type", - "label": "AssetTypeToParts", "tags": [], + "label": "AssetTypeToParts", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 223 - }, "signature": [ "Record & Record" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 228 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.BaseAgentActionSOAttributes", "type": "Type", - "label": "BaseAgentActionSOAttributes", "tags": [], + "label": "BaseAgentActionSOAttributes", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 94 - }, "signature": [ { "pluginId": "fleet", @@ -12959,357 +14119,422 @@ "text": "AgentPolicyActionSOAttributes" } ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 94 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CategoryId", "type": "Type", - "label": "CategoryId", "tags": [], + "label": "CategoryId", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 208 - }, "signature": [ "string" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 213 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CategorySummaryList", "type": "Type", - "label": "CategorySummaryList", "tags": [], + "label": "CategorySummaryList", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 207 - }, "signature": [ "CategorySummaryItem[]" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 212 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DATA_STREAM_API_ROOT", "type": "string", + "tags": [], "label": "DATA_STREAM_API_ROOT", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 12 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DataType", "type": "Type", - "label": "DataType", "tags": [], + "label": "DataType", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 80 - }, "signature": [ "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 85 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], - "id": "def-common.DEFAULT_AGENT_POLICIES_PACKAGES", + "parentPluginId": "fleet", + "id": "def-common.DEFAULT_PACKAGES", "type": "Array", - "label": "DEFAULT_AGENT_POLICIES_PACKAGES", + "tags": [], + "label": "DEFAULT_PACKAGES", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 48 - }, "signature": [ - "\"system\"[]" + "{ name: \"endpoint\" | \"fleet_server\" | \"system\" | \"elastic_agent\"; version: string; }[]" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 59 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DefaultPackages", "type": "Type", - "label": "DefaultPackages", "tags": [], + "label": "DefaultPackages", "description": [], + "signature": [ + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 377 + "lineNumber": 382 }, - "signature": [ - "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DeletePackagePoliciesResponse", "type": "Type", - "label": "DeletePackagePoliciesResponse", "tags": [], + "label": "DeletePackagePoliciesResponse", "description": [], + "signature": [ + "{ id: string; name?: string | undefined; success: boolean; }[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "lineNumber": 55 }, - "signature": [ - "{ id: string; name?: string | undefined; success: boolean; }[]" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DetailViewPanelName", "type": "Type", - "label": "DetailViewPanelName", "tags": [], + "label": "DetailViewPanelName", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 38 - }, "signature": [ "\"custom\" | \"settings\" | \"overview\" | \"policies\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 43 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ElasticsearchAssetParts", "type": "Type", - "label": "ElasticsearchAssetParts", "tags": [], + "label": "ElasticsearchAssetParts", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 235 - }, "signature": [ "AssetParts & { service: Extract; type: ElasticsearchAssetType; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 240 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ElasticsearchAssetTypeToParts", "type": "Type", - "label": "ElasticsearchAssetTypeToParts", "tags": [], + "label": "ElasticsearchAssetTypeToParts", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 241 - }, "signature": [ "{ component_template: ElasticsearchAssetParts[]; ingest_pipeline: ElasticsearchAssetParts[]; index_template: ElasticsearchAssetParts[]; ilm_policy: ElasticsearchAssetParts[]; transform: ElasticsearchAssetParts[]; data_stream_ilm_policy: ElasticsearchAssetParts[]; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 246 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ENROLLMENT_API_KEYS_INDEX", "type": "string", + "tags": [], "label": "ENROLLMENT_API_KEYS_INDEX", "description": [], + "signature": [ + "\".fleet-enrollment-api-keys\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/enrollment_api_key.ts", "lineNumber": 10 }, - "signature": [ - "\".fleet-enrollment-api-keys\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ENROLLMENT_API_KEYS_SAVED_OBJECT_TYPE", "type": "string", + "tags": [], "label": "ENROLLMENT_API_KEYS_SAVED_OBJECT_TYPE", "description": [], + "signature": [ + "\"fleet-enrollment-api-keys\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/enrollment_api_key.ts", "lineNumber": 8 }, - "signature": [ - "\"fleet-enrollment-api-keys\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.EnrollmentAPIKeySOAttributes", "type": "Type", - "label": "EnrollmentAPIKeySOAttributes", "tags": [], + "label": "EnrollmentAPIKeySOAttributes", "description": [], + "signature": [ + "{ name?: string | undefined; active: boolean; created_at: string; policy_id?: string | undefined; api_key: string; api_key_id: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", "lineNumber": 18 }, - "signature": [ - "{ name?: string | undefined; active: boolean; policy_id?: string | undefined; created_at: string; api_key: string; api_key_id: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROOT", "type": "string", + "tags": [], "label": "EPM_API_ROOT", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 11 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.EpmPackageInstallStatus", "type": "Type", - "label": "EpmPackageInstallStatus", "tags": [], + "label": "EpmPackageInstallStatus", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 36 - }, "signature": [ "\"installed\" | \"installing\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 41 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.EsAssetReference", "type": "Type", - "label": "EsAssetReference", "tags": [], + "label": "EsAssetReference", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 367 - }, "signature": [ "Pick & { type: ElasticsearchAssetType; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 372 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FLEET_API_ROOT_7_9", "type": "string", + "tags": [], "label": "FLEET_API_ROOT_7_9", "description": [], + "signature": [ + "\"/api/ingest_manager/fleet\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 15 }, - "signature": [ - "\"/api/ingest_manager/fleet\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FLEET_SERVER_ARTIFACTS_INDEX", "type": "string", + "tags": [], "label": "FLEET_SERVER_ARTIFACTS_INDEX", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/index.ts", - "lineNumber": 27 - }, "signature": [ "\".fleet-artifacts\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "lineNumber": 28 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FLEET_SERVER_INDICES", "type": "Array", + "tags": [], "label": "FLEET_SERVER_INDICES", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/index.ts", - "lineNumber": 29 - }, "signature": [ "string[]" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "lineNumber": 32 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FLEET_SERVER_INDICES_VERSION", "type": "number", + "tags": [], "label": "FLEET_SERVER_INDICES_VERSION", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/index.ts", - "lineNumber": 25 - }, "signature": [ "1" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "lineNumber": 26 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FLEET_SERVER_PACKAGE", "type": "string", + "tags": [], "label": "FLEET_SERVER_PACKAGE", "description": [], + "signature": [ + "\"fleet_server\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", "lineNumber": 12 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FLEET_SERVER_SERVERS_INDEX", + "type": "string", + "tags": [], + "label": "FLEET_SERVER_SERVERS_INDEX", + "description": [], "signature": [ - "\"fleet_server\"" + "\".fleet-servers\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "lineNumber": 30 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetAgentPoliciesResponseItem", "type": "Type", - "label": "GetAgentPoliciesResponseItem", "tags": [], + "label": "GetAgentPoliciesResponseItem", "description": [], + "signature": [ + "AgentPolicy & { agents?: number | undefined; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "lineNumber": 18 }, - "signature": [ - "AgentPolicy & { agents?: number | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GLOBAL_SETTINGS_SAVED_OBJECT_TYPE", "type": "string", + "tags": [], "label": "GLOBAL_SETTINGS_SAVED_OBJECT_TYPE", "description": [], + "signature": [ + "\"ingest_manager_settings\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/settings.ts", "lineNumber": 8 }, - "signature": [ - "\"ingest_manager_settings\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InputsOverride", "type": "Type", - "label": "InputsOverride", "tags": [], + "label": "InputsOverride", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "lineNumber": 15 - }, "signature": [ "Partial & { vars?: (Record & { name: string; })[] | undefined; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 15 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.INSTALL_SCRIPT_API_ROUTES", "type": "string", + "tags": [], "label": "INSTALL_SCRIPT_API_ROUTES", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 121 + "lineNumber": 116 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.Installable", "type": "Type", - "label": "Installable", "tags": [], + "label": "Installable", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 351 - }, "signature": [ { "pluginId": "fleet", @@ -13363,18 +14592,20 @@ }, "" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 356 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InstallablePackage", "type": "Type", - "label": "InstallablePackage", "tags": [], + "label": "InstallablePackage", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 82 - }, "signature": [ { "pluginId": "fleet", @@ -13392,270 +14623,306 @@ "text": "ArchivePackage" } ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 87 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InstallationStatus", "type": "Type", - "label": "InstallationStatus", "tags": [], + "label": "InstallationStatus", "description": [], + "signature": [ + "{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 24 }, - "signature": [ - "{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.Installed", "type": "Type", - "label": "Installed", "tags": [], + "label": "Installed", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 353 - }, "signature": [ "T & { status: InstallationStatus['Installed']; savedObject: SavedObject; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 358 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InstallSource", "type": "Type", - "label": "InstallSource", "tags": [], + "label": "InstallSource", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 34 - }, "signature": [ "\"registry\" | \"upload\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 39 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InstallType", "type": "Type", - "label": "InstallType", "tags": [], + "label": "InstallType", "description": [], + "signature": [ + "\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 33 + "lineNumber": 38 }, - "signature": [ - "\"update\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.KibanaAssetParts", "type": "Type", - "label": "KibanaAssetParts", "tags": [], + "label": "KibanaAssetParts", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 230 - }, "signature": [ "AssetParts & { service: Extract; type: KibanaAssetType; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 235 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.KibanaAssetReference", "type": "Type", - "label": "KibanaAssetReference", "tags": [], + "label": "KibanaAssetReference", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 364 - }, "signature": [ "Pick & { type: KibanaSavedObjectType; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 369 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.KibanaAssetTypeToParts", "type": "Type", - "label": "KibanaAssetTypeToParts", "tags": [], + "label": "KibanaAssetTypeToParts", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 240 - }, "signature": [ "{ dashboard: KibanaAssetParts[]; visualization: KibanaAssetParts[]; search: KibanaAssetParts[]; index_pattern: KibanaAssetParts[]; map: KibanaAssetParts[]; lens: KibanaAssetParts[]; security_rule: KibanaAssetParts[]; ml_module: KibanaAssetParts[]; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 245 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.LIMITED_CONCURRENCY_ROUTE_TAG", "type": "string", + "tags": [], "label": "LIMITED_CONCURRENCY_ROUTE_TAG", "description": [], + "signature": [ + "\"ingest:limited-concurrency\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 17 }, - "signature": [ - "\"ingest:limited-concurrency\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.MAX_TIME_COMPLETE_INSTALL", "type": "number", + "tags": [], "label": "MAX_TIME_COMPLETE_INSTALL", "description": [], + "signature": [ + "60000" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", "lineNumber": 10 }, - "signature": [ - "60000" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.NotInstalled", "type": "Type", - "label": "NotInstalled", "tags": [], + "label": "NotInstalled", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 358 - }, "signature": [ "T & { status: InstallationStatus['NotInstalled']; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 363 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.Output", "type": "Type", - "label": "Output", "tags": [], + "label": "Output", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 28 - }, "signature": [ "NewOutput & { id: string; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 26 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.OUTPUT_SAVED_OBJECT_TYPE", "type": "string", + "tags": [], "label": "OUTPUT_SAVED_OBJECT_TYPE", "description": [], + "signature": [ + "\"ingest-outputs\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/output.ts", "lineNumber": 10 }, - "signature": [ - "\"ingest-outputs\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.OutputSOAttributes", "type": "Type", - "label": "OutputSOAttributes", "tags": [], + "label": "OutputSOAttributes", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 26 - }, "signature": [ "NewOutput" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 24 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.OutputType", "type": "Type", - "label": "OutputType", "tags": [], + "label": "OutputType", "description": [], + "signature": [ + "{ readonly Elasticsearch: \"elasticsearch\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", "lineNumber": 11 }, - "signature": [ - "{ readonly Elasticsearch: \"elasticsearch\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PACKAGE_POLICY_API_ROOT", "type": "string", + "tags": [], "label": "PACKAGE_POLICY_API_ROOT", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 13 }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PACKAGE_POLICY_SAVED_OBJECT_TYPE", "type": "string", + "tags": [], "label": "PACKAGE_POLICY_SAVED_OBJECT_TYPE", "description": [], + "signature": [ + "\"ingest-package-policies\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/package_policy.ts", "lineNumber": 8 }, - "signature": [ - "\"ingest-package-policies\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageAssetReference", "type": "Type", - "label": "PackageAssetReference", "tags": [], + "label": "PackageAssetReference", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 371 - }, "signature": [ "Pick & { type: typeof ASSETS_SAVED_OBJECT_TYPE; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 376 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageInfo", "type": "Type", - "label": "PackageInfo", "tags": [], - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 330 - }, + "label": "PackageInfo", + "description": [], "signature": [ { "pluginId": "fleet", @@ -13697,33 +14964,37 @@ "text": "RegistryPackage" } ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 335 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageList", "type": "Type", - "label": "PackageList", "tags": [], + "label": "PackageList", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 326 - }, "signature": [ "Installable>[]" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 331 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageListItem", "type": "Type", - "label": "PackageListItem", "tags": [], + "label": "PackageListItem", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 328 - }, "signature": [ { "pluginId": "fleet", @@ -13758,198 +15029,275 @@ }, ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\">>" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 333 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackagePolicyConfigRecord", "type": "Type", - "label": "PackagePolicyConfigRecord", "tags": [], + "label": "PackagePolicyConfigRecord", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 19 - }, "signature": [ "{ [x: string]: PackagePolicyConfigRecordEntry; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackagePolicySOAttributes", "type": "Type", - "label": "PackagePolicySOAttributes", "tags": [], + "label": "PackagePolicySOAttributes", "description": [], + "signature": [ + "{ enabled: boolean; description?: string | undefined; name: string; package?: PackagePolicyPackage | undefined; updated_at: string; created_at: string; created_by: string; updated_by: string; namespace: string; inputs: PackagePolicyInput[]; policy_id: string; output_id: string; revision: number; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 75 + "lineNumber": 76 }, - "signature": [ - "{ enabled: boolean; description?: string | undefined; name: string; package?: PackagePolicyPackage | undefined; updated_at: string; namespace: string; inputs: PackagePolicyInput[]; policy_id: string; output_id: string; updated_by: string; revision: number; created_at: string; created_by: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PACKAGES_SAVED_OBJECT_TYPE", "type": "string", + "tags": [], "label": "PACKAGES_SAVED_OBJECT_TYPE", "description": [], + "signature": [ + "\"epm-packages\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", "lineNumber": 8 }, - "signature": [ - "\"epm-packages\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackagesGroupedByStatus", "type": "Type", - "label": "PackagesGroupedByStatus", "tags": [], + "label": "PackagesGroupedByStatus", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 329 - }, "signature": [ "{ installed: PackageList; not_installed: PackageList; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 334 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageSpecCategory", "type": "Type", - "label": "PackageSpecCategory", "tags": [], + "label": "PackageSpecCategory", "description": [], + "signature": [ + "\"custom\" | \"security\" | \"monitoring\" | \"network\" | \"cloud\" | \"kubernetes\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"languages\" | \"message_queue\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 28 }, - "signature": [ - "\"custom\" | \"security\" | \"monitoring\" | \"cloud\" | \"network\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageSpecConditions", "type": "Type", - "label": "PackageSpecConditions", "tags": [], + "label": "PackageSpecConditions", "description": [], + "signature": [ + "{ kibana: { version: string; }; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 53 }, - "signature": [ - "{ kibana: { version: string; }; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PLUGIN_ID", "type": "string", + "tags": [], "label": "PLUGIN_ID", "description": [], + "signature": [ + "\"fleet\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/plugin.ts", "lineNumber": 8 }, - "signature": [ - "\"fleet\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostBulkAgentReassignResponse", "type": "Type", - "label": "PostBulkAgentReassignResponse", "tags": [], + "label": "PostBulkAgentReassignResponse", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 178 - }, "signature": [ "{ [x: string]: { success: boolean; error?: string | undefined; }; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 126 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostBulkAgentUnenrollResponse", "type": "Type", - "label": "PostBulkAgentUnenrollResponse", "tags": [], + "label": "PostBulkAgentUnenrollResponse", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 124 - }, "signature": [ "{ [x: string]: { success: boolean; error?: string | undefined; }; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 72 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostBulkAgentUpgradeResponse", "type": "Type", - "label": "PostBulkAgentUpgradeResponse", "tags": [], + "label": "PostBulkAgentUpgradeResponse", "description": [], + "signature": [ + "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 150 + "lineNumber": 98 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE", + "description": [], "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + "\"fleet-preconfiguration-deletion-record\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 12 + }, + "deprecated": false, "initialIsOpen": false }, { - "id": "def-common.RegistryPackage", - "type": "Type", - "label": "RegistryPackage", + "parentPluginId": "fleet", + "id": "def-common.PRECONFIGURATION_LATEST_KEYWORD", + "type": "string", "tags": [], + "label": "PRECONFIGURATION_LATEST_KEYWORD", "description": [], + "signature": [ + "\"latest\"" + ], "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 88 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 15 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PreconfiguredPackage", + "type": "Type", + "tags": [], + "label": "PreconfiguredPackage", + "description": [], "signature": [ - "PackageSpecManifest & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" + "{ name: string; version: string; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 31 + }, + "deprecated": false, "initialIsOpen": false }, { - "id": "def-common.RegistryRelease", + "parentPluginId": "fleet", + "id": "def-common.RegistryPackage", "type": "Type", - "label": "RegistryRelease", "tags": [], + "label": "RegistryPackage", "description": [], + "signature": [ + "PackageSpecManifest & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 115 + "lineNumber": 93 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryRelease", + "type": "Type", + "tags": [], + "label": "RegistryRelease", + "description": [], "signature": [ "\"experimental\" | \"beta\" | \"ga\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 120 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistrySearchResult", "type": "Type", - "label": "RegistrySearchResult", "tags": [], + "label": "RegistrySearchResult", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 187 - }, "signature": [ "{ type?: \"integration\" | undefined; description: string; title: string; name: string; version: string; path: string; download: string; internal?: boolean | undefined; data_streams?: RegistryDataStream[] | undefined; release: \"experimental\" | \"beta\" | \"ga\"; icons?: (", { @@ -13961,108 +15309,139 @@ }, "[] & RegistryImage[]) | undefined; policy_templates?: RegistryPolicyTemplate[] | undefined; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 192 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistrySearchResults", "type": "Type", - "label": "RegistrySearchResults", "tags": [], + "label": "RegistrySearchResults", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 185 - }, "signature": [ "Pick[]" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 190 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryVarType", "type": "Type", - "label": "RegistryVarType", "tags": [], + "label": "RegistryVarType", "description": [], + "signature": [ + "\"string\" | \"text\" | \"password\" | \"integer\" | \"bool\" | \"yaml\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 281 + "lineNumber": 286 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.REQUIRED_PACKAGES", + "type": "Array", + "tags": [], + "label": "REQUIRED_PACKAGES", + "description": [], "signature": [ - "\"string\" | \"text\" | \"password\" | \"integer\" | \"bool\" | \"yaml\"" + "{ name: \"endpoint\" | \"fleet_server\" | \"system\" | \"elastic_agent\"; version: string; }[]" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 65 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RequiredPackage", "type": "Type", - "label": "RequiredPackage", "tags": [], + "label": "RequiredPackage", "description": [], + "signature": [ + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 375 + "lineNumber": 380 }, - "signature": [ - "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RequirementsByServiceName", "type": "Type", - "label": "RequirementsByServiceName", "tags": [], + "label": "RequirementsByServiceName", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 215 - }, "signature": [ "undefined | Record<\"kibana\", { version: string; }>" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 220 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RequirementVersion", "type": "Type", - "label": "RequirementVersion", "tags": [], + "label": "RequirementVersion", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 176 - }, "signature": [ "string" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 181 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RequirementVersionRange", "type": "Type", - "label": "RequirementVersionRange", "tags": [], + "label": "RequirementVersionRange", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 177 - }, "signature": [ "string" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 182 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ScreenshotItem", "type": "Type", - "label": "ScreenshotItem", "tags": [], + "label": "ScreenshotItem", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 203 - }, "signature": [ { "pluginId": "fleet", @@ -14080,2614 +15459,2917 @@ "text": "PackageSpecScreenshot" } ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 208 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ServiceName", "type": "Type", - "label": "ServiceName", "tags": [], + "label": "ServiceName", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 39 - }, "signature": [ "\"kibana\" | \"elasticsearch\"" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 44 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.SETUP_API_ROUTE", "type": "string", + "tags": [], "label": "SETUP_API_ROUTE", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 119 + "lineNumber": 114 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.SimplifiedAgentStatus", "type": "Type", - "label": "SimplifiedAgentStatus", "tags": [], + "label": "SimplifiedAgentStatus", "description": [], + "signature": [ + "\"offline\" | \"inactive\" | \"updating\" | \"healthy\" | \"unhealthy\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 32 }, - "signature": [ - "\"offline\" | \"inactive\" | \"updating\" | \"healthy\" | \"unhealthy\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.SO_SEARCH_LIMIT", "type": "number", + "tags": [], "label": "SO_SEARCH_LIMIT", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/index.ts", - "lineNumber": 23 - }, "signature": [ "10000" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "lineNumber": 24 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.UpdateAgentPolicyRequest", "type": "Type", - "label": "UpdateAgentPolicyRequest", "tags": [], + "label": "UpdateAgentPolicyRequest", "description": [], + "signature": [ + "GetOneAgentPolicyRequest & { body: NewAgentPolicy; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "lineNumber": 45 }, - "signature": [ - "GetOneAgentPolicyRequest & { body: NewAgentPolicy; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.UpdatePackagePolicyRequest", "type": "Type", - "label": "UpdatePackagePolicyRequest", "tags": [], + "label": "UpdatePackagePolicyRequest", "description": [], + "signature": [ + "GetOnePackagePolicyRequest & { body: UpdatePackagePolicy; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "lineNumber": 43 }, - "signature": [ - "GetOnePackagePolicyRequest & { body: UpdatePackagePolicy; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.UpdatePackagePolicyResponse", "type": "Type", - "label": "UpdatePackagePolicyResponse", "tags": [], + "label": "UpdatePackagePolicyResponse", "description": [], + "signature": [ + "CreatePackagePolicyResponse" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "lineNumber": 47 }, - "signature": [ - "CreatePackagePolicyResponse" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ValueOf", "type": "Type", - "label": "ValueOf", "tags": [], + "label": "ValueOf", "description": [ "\nCreates a Union Type for all the values of an object" ], - "source": { - "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 47 - }, "signature": [ "T[keyof T]" ], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 49 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES", "type": "Object", "tags": [], + "label": "AGENT_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.LIST_PATTERN", "type": "string", + "tags": [], "label": "LIST_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 83 - } + "lineNumber": 84 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.INFO_PATTERN", "type": "string", + "tags": [], "label": "INFO_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 84 - } + "lineNumber": 85 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.UPDATE_PATTERN", "type": "string", + "tags": [], "label": "UPDATE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 85 - } + "lineNumber": 86 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.DELETE_PATTERN", "type": "string", - "label": "DELETE_PATTERN", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 86 - } - }, - { "tags": [], - "id": "def-common.AGENT_API_ROUTES.EVENTS_PATTERN", - "type": "string", - "label": "EVENTS_PATTERN", + "label": "DELETE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 87 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.CHECKIN_PATTERN", "type": "string", + "tags": [], "label": "CHECKIN_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 88 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.ACKS_PATTERN", "type": "string", + "tags": [], "label": "ACKS_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 89 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.ACTIONS_PATTERN", "type": "string", + "tags": [], "label": "ACTIONS_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 90 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.ENROLL_PATTERN", "type": "string", + "tags": [], "label": "ENROLL_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 91 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.UNENROLL_PATTERN", "type": "string", + "tags": [], "label": "UNENROLL_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 92 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.BULK_UNENROLL_PATTERN", "type": "string", + "tags": [], "label": "BULK_UNENROLL_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 93 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.REASSIGN_PATTERN", "type": "string", + "tags": [], "label": "REASSIGN_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 94 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.BULK_REASSIGN_PATTERN", "type": "string", + "tags": [], "label": "BULK_REASSIGN_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 95 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.STATUS_PATTERN", "type": "string", + "tags": [], "label": "STATUS_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 96 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.UPGRADE_PATTERN", "type": "string", + "tags": [], "label": "UPGRADE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 97 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.BULK_UPGRADE_PATTERN", "type": "string", + "tags": [], "label": "BULK_UPGRADE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 98 - } + }, + "deprecated": false } ], - "description": [], - "label": "AGENT_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 82 - }, "initialIsOpen": false }, { - "id": "def-common.AGENT_API_ROUTES_7_9", + "parentPluginId": "fleet", + "id": "def-common.AGENT_POLICY_API_ROUTES", "type": "Object", "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.AGENT_API_ROUTES_7_9.CHECKIN_PATTERN", - "type": "string", - "label": "CHECKIN_PATTERN", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 101 - } - }, - { - "tags": [], - "id": "def-common.AGENT_API_ROUTES_7_9.ACKS_PATTERN", - "type": "string", - "label": "ACKS_PATTERN", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 102 - } - }, - { - "tags": [], - "id": "def-common.AGENT_API_ROUTES_7_9.ENROLL_PATTERN", - "type": "string", - "label": "ENROLL_PATTERN", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 103 - } - } - ], + "label": "AGENT_POLICY_API_ROUTES", "description": [], - "label": "AGENT_API_ROUTES_7_9", "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 100 + "lineNumber": 52 }, - "initialIsOpen": false - }, - { - "id": "def-common.AGENT_POLICY_API_ROUTES", - "type": "Object", - "tags": [], + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_API_ROUTES.LIST_PATTERN", "type": "string", + "tags": [], "label": "LIST_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 53 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_API_ROUTES.INFO_PATTERN", "type": "string", + "tags": [], "label": "INFO_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 54 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_API_ROUTES.CREATE_PATTERN", "type": "string", + "tags": [], "label": "CREATE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_API_ROUTES.UPDATE_PATTERN", "type": "string", + "tags": [], "label": "UPDATE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 56 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_API_ROUTES.COPY_PATTERN", "type": "string", + "tags": [], "label": "COPY_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_API_ROUTES.DELETE_PATTERN", "type": "string", + "tags": [], "label": "DELETE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 58 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_PATTERN", "type": "string", + "tags": [], "label": "FULL_INFO_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 59 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_DOWNLOAD_PATTERN", "type": "string", + "tags": [], "label": "FULL_INFO_DOWNLOAD_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 60 - } + }, + "deprecated": false } ], - "description": [], - "label": "AGENT_POLICY_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 52 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.agentAssetTypes", "type": "Object", + "tags": [], "label": "agentAssetTypes", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "lineNumber": 23 - }, "signature": [ "{ readonly Input: \"input\"; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 24 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService", "type": "Object", "tags": [], + "label": "agentPolicyRouteService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getListPath", "type": "Function", - "children": [], + "tags": [], + "label": "getListPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getListPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 87 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getInfoPath", "type": "Function", + "tags": [], + "label": "getInfoPath", + "description": [], + "signature": [ + "(agentPolicyId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 91 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getInfoPath.$1", "type": "string", + "tags": [], "label": "agentPolicyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 91 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentPolicyId: string) => string" - ], - "description": [], - "label": "getInfoPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 91 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getCreatePath", "type": "Function", - "children": [], + "tags": [], + "label": "getCreatePath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getCreatePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 95 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getUpdatePath", "type": "Function", + "tags": [], + "label": "getUpdatePath", + "description": [], + "signature": [ + "(agentPolicyId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 99 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getUpdatePath.$1", "type": "string", + "tags": [], "label": "agentPolicyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 99 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentPolicyRouteService.getCopyPath", + "type": "Function", + "tags": [], + "label": "getCopyPath", + "description": [], "signature": [ "(agentPolicyId: string) => string" ], - "description": [], - "label": "getUpdatePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 99 + "lineNumber": 103 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.agentPolicyRouteService.getCopyPath", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getCopyPath.$1", "type": "string", + "tags": [], "label": "agentPolicyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 103 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentPolicyId: string) => string" - ], - "description": [], - "label": "getCopyPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 103 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getDeletePath", "type": "Function", - "children": [], + "tags": [], + "label": "getDeletePath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getDeletePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 107 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getInfoFullPath", "type": "Function", + "tags": [], + "label": "getInfoFullPath", + "description": [], + "signature": [ + "(agentPolicyId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 111 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getInfoFullPath.$1", "type": "string", + "tags": [], "label": "agentPolicyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 111 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath", + "type": "Function", + "tags": [], + "label": "getInfoFullDownloadPath", + "description": [], "signature": [ "(agentPolicyId: string) => string" ], - "description": [], - "label": "getInfoFullPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 111 + "lineNumber": 115 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath.$1", "type": "string", + "tags": [], "label": "agentPolicyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 115 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentPolicyId: string) => string" - ], - "description": [], - "label": "getInfoFullDownloadPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 115 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "agentPolicyRouteService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 86 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.agentPolicyStatuses", "type": "Object", + "tags": [], "label": "agentPolicyStatuses", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 14 - }, "signature": [ "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 10 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.agentRouteService", "type": "Object", "tags": [], + "label": "agentRouteService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 134 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getInfoPath", "type": "Function", - "children": [ - { - "id": "def-common.agentRouteService.getInfoPath.$1", - "type": "string", - "label": "agentId", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 135 - } - } - ], + "tags": [], + "label": "getInfoPath", + "description": [], "signature": [ "(agentId: string) => string" ], - "description": [], - "label": "getInfoPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 135 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.agentRouteService.getUpdatePath", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.agentRouteService.getUpdatePath.$1", + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getInfoPath.$1", "type": "string", + "tags": [], "label": "agentId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 136 - } + "lineNumber": 135 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getUpdatePath", + "type": "Function", + "tags": [], + "label": "getUpdatePath", + "description": [], "signature": [ "(agentId: string) => string" ], - "description": [], - "label": "getUpdatePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 136 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.agentRouteService.getEventsPath", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.agentRouteService.getEventsPath.$1", + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getUpdatePath.$1", "type": "string", + "tags": [], "label": "agentId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 137 - } + "lineNumber": 136 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getUnenrollPath", + "type": "Function", + "tags": [], + "label": "getUnenrollPath", + "description": [], "signature": [ "(agentId: string) => string" ], - "description": [], - "label": "getEventsPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 137 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.agentRouteService.getUnenrollPath", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getUnenrollPath.$1", "type": "string", + "tags": [], "label": "agentId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 138 - } + "lineNumber": 137 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentId: string) => string" - ], - "description": [], - "label": "getUnenrollPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 138 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getBulkUnenrollPath", "type": "Function", - "children": [], + "tags": [], + "label": "getBulkUnenrollPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getBulkUnenrollPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 140 + "lineNumber": 139 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getReassignPath", "type": "Function", + "tags": [], + "label": "getReassignPath", + "description": [], + "signature": [ + "(agentId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 140 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getReassignPath.$1", "type": "string", + "tags": [], "label": "agentId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 141 - } + "lineNumber": 140 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentId: string) => string" - ], - "description": [], - "label": "getReassignPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 141 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getBulkReassignPath", "type": "Function", - "children": [], + "tags": [], + "label": "getBulkReassignPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getBulkReassignPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 143 + "lineNumber": 142 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getUpgradePath", "type": "Function", + "tags": [], + "label": "getUpgradePath", + "description": [], + "signature": [ + "(agentId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 143 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getUpgradePath.$1", "type": "string", + "tags": [], "label": "agentId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 144 - } + "lineNumber": 143 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentId: string) => string" - ], - "description": [], - "label": "getUpgradePath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 144 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getBulkUpgradePath", "type": "Function", - "children": [], + "tags": [], + "label": "getBulkUpgradePath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getBulkUpgradePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 146 + "lineNumber": 145 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getListPath", "type": "Function", - "children": [], + "tags": [], + "label": "getListPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getListPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 147 + "lineNumber": 146 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getStatusPath", "type": "Function", - "children": [], + "tags": [], + "label": "getStatusPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getStatusPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 148 + "lineNumber": 147 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getCreateActionPath", "type": "Function", + "tags": [], + "label": "getCreateActionPath", + "description": [], + "signature": [ + "(agentId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 148 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.agentRouteService.getCreateActionPath.$1", "type": "string", + "tags": [], "label": "agentId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 149 - } + "lineNumber": 148 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentId: string) => string" - ], - "description": [], - "label": "getCreateActionPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 149 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "agentRouteService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 134 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AGENTS_SETUP_API_ROUTES", "type": "Object", "tags": [], + "label": "AGENTS_SETUP_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 109 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENTS_SETUP_API_ROUTES.INFO_PATTERN", "type": "string", + "tags": [], "label": "INFO_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 115 - } + "lineNumber": 110 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENTS_SETUP_API_ROUTES.CREATE_PATTERN", "type": "string", + "tags": [], "label": "CREATE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 116 - } + "lineNumber": 111 + }, + "deprecated": false } ], - "description": [], - "label": "AGENTS_SETUP_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 114 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentStatusKueryHelper", "type": "Object", - "label": "AgentStatusKueryHelper", "tags": [], + "label": "AgentStatusKueryHelper", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/services/index.ts", - "lineNumber": 9 - }, "signature": [ "typeof ", "x-pack/plugins/fleet/common/services/agent_status" ], + "source": { + "path": "x-pack/plugins/fleet/common/services/index.ts", + "lineNumber": 9 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.APP_API_ROUTES", "type": "Object", "tags": [], + "label": "APP_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 77 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.APP_API_ROUTES.CHECK_PERMISSIONS_PATTERN", "type": "string", + "tags": [], "label": "CHECK_PERMISSIONS_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 78 - } + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.APP_API_ROUTES.GENERATE_SERVICE_TOKEN_PATTERN", + "type": "string", + "tags": [], + "label": "GENERATE_SERVICE_TOKEN_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 79 + }, + "deprecated": false } ], - "description": [], - "label": "APP_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 77 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.appRoutesService", "type": "Object", "tags": [], + "label": "appRoutesService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 164 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.appRoutesService.getCheckPermissionsPath", "type": "Function", - "children": [], + "tags": [], + "label": "getCheckPermissionsPath", + "description": [], "signature": [ "() => string" ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 165 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.appRoutesService.getRegenerateServiceTokenPath", + "type": "Function", + "tags": [], + "label": "getRegenerateServiceTokenPath", "description": [], - "label": "getCheckPermissionsPath", + "signature": [ + "() => string" + ], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 166 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "description": [], - "label": "appRoutesService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 165 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DATA_STREAM_API_ROUTES", "type": "Object", "tags": [], + "label": "DATA_STREAM_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DATA_STREAM_API_ROUTES.LIST_PATTERN", "type": "string", + "tags": [], "label": "LIST_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 39 - } + }, + "deprecated": false } ], - "description": [], - "label": "DATA_STREAM_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 38 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.dataStreamRouteService", "type": "Object", "tags": [], + "label": "dataStreamRouteService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 123 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.dataStreamRouteService.getListPath", "type": "Function", - "children": [], + "tags": [], + "label": "getListPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getListPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 124 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "description": [], - "label": "dataStreamRouteService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 123 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.dataTypes", "type": "Object", + "tags": [], "label": "dataTypes", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "lineNumber": 27 - }, "signature": [ "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 28 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY", "type": "Object", "tags": [], + "label": "DEFAULT_AGENT_POLICY", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 23 - } + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 25 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 24 - } + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 26 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.description", "type": "string", - "label": "description", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 25 - } - }, - { "tags": [], - "id": "def-common.DEFAULT_AGENT_POLICY.status", - "type": "string", - "label": "status", + "label": "description", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 26 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 27 }, - "signature": [ - "\"active\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.package_policies", "type": "Array", + "tags": [], "label": "package_policies", "description": [], + "signature": [ + "{ name: string; package: { name: \"system\"; }; }[]" + ], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 27 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 28 }, - "signature": [ - "never[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.is_default", "type": "boolean", + "tags": [], "label": "is_default", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 28 - }, "signature": [ "true" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 36 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.is_managed", "type": "boolean", + "tags": [], "label": "is_managed", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 29 - }, "signature": [ "false" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.monitoring_enabled", "type": "Array", + "tags": [], "label": "monitoring_enabled", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 30 - }, "signature": [ "(\"metrics\" | \"logs\")[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 38 + }, + "deprecated": false } ], - "description": [], - "label": "DEFAULT_AGENT_POLICY", - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY", "type": "Object", "tags": [], + "label": "DEFAULT_FLEET_SERVER_AGENT_POLICY", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 37 - } + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 42 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 38 - } + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 43 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.description", "type": "string", - "label": "description", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 39 - } - }, - { "tags": [], - "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.status", - "type": "string", - "label": "status", + "label": "description", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 40 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 44 }, - "signature": [ - "\"active\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.package_policies", "type": "Array", + "tags": [], "label": "package_policies", "description": [], + "signature": [ + "{ name: string; package: { name: \"fleet_server\"; }; }[]" + ], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 41 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 45 }, - "signature": [ - "never[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default", "type": "boolean", + "tags": [], "label": "is_default", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 42 - }, "signature": [ "false" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 53 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default_fleet_server", "type": "boolean", + "tags": [], "label": "is_default_fleet_server", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 43 - }, "signature": [ "true" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 54 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_managed", "type": "boolean", + "tags": [], "label": "is_managed", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 44 - }, "signature": [ "false" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.monitoring_enabled", "type": "Array", + "tags": [], "label": "monitoring_enabled", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 45 - }, "signature": [ "(\"metrics\" | \"logs\")[]" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 56 + }, + "deprecated": false } ], - "description": [], - "label": "DEFAULT_FLEET_SERVER_AGENT_POLICY", - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 33 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DEFAULT_OUTPUT", "type": "Object", "tags": [], + "label": "DEFAULT_OUTPUT", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/output.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_OUTPUT.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/output.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_OUTPUT.is_default", "type": "boolean", + "tags": [], "label": "is_default", "description": [], + "signature": [ + "true" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/output.ts", "lineNumber": 18 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_OUTPUT.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "\"elasticsearch\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/output.ts", "lineNumber": 19 }, - "signature": [ - "\"elasticsearch\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_OUTPUT.hosts", "type": "Array", + "tags": [], "label": "hosts", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/output.ts", "lineNumber": 20 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "description": [], - "label": "DEFAULT_OUTPUT", - "source": { - "path": "x-pack/plugins/fleet/common/constants/output.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.defaultPackages", "type": "Object", + "tags": [], "label": "defaultPackages", "description": [], + "signature": [ + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "lineNumber": 21 + "lineNumber": 22 }, - "signature": [ - "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ENROLLMENT_API_KEY_ROUTES", "type": "Object", "tags": [], + "label": "ENROLLMENT_API_KEY_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 101 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ENROLLMENT_API_KEY_ROUTES.CREATE_PATTERN", "type": "string", + "tags": [], "label": "CREATE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 107 - } + "lineNumber": 102 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ENROLLMENT_API_KEY_ROUTES.LIST_PATTERN", "type": "string", + "tags": [], "label": "LIST_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 108 - } + "lineNumber": 103 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ENROLLMENT_API_KEY_ROUTES.INFO_PATTERN", "type": "string", + "tags": [], "label": "INFO_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 109 - } + "lineNumber": 104 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.ENROLLMENT_API_KEY_ROUTES.DELETE_PATTERN", "type": "string", + "tags": [], "label": "DELETE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 110 - } + "lineNumber": 105 + }, + "deprecated": false } ], - "description": [], - "label": "ENROLLMENT_API_KEY_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 106 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.enrollmentAPIKeyRouteService", "type": "Object", "tags": [], + "label": "enrollmentAPIKeyRouteService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 169 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.enrollmentAPIKeyRouteService.getListPath", "type": "Function", - "children": [], + "tags": [], + "label": "getListPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getListPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 170 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.enrollmentAPIKeyRouteService.getCreatePath", "type": "Function", - "children": [], + "tags": [], + "label": "getCreatePath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getCreatePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 171 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.enrollmentAPIKeyRouteService.getInfoPath", "type": "Function", + "tags": [], + "label": "getInfoPath", + "description": [], + "signature": [ + "(keyId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 172 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.enrollmentAPIKeyRouteService.getInfoPath.$1", "type": "string", + "tags": [], "label": "keyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 172 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.enrollmentAPIKeyRouteService.getDeletePath", + "type": "Function", + "tags": [], + "label": "getDeletePath", + "description": [], "signature": [ "(keyId: string) => string" ], - "description": [], - "label": "getInfoPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 172 + "lineNumber": 173 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.enrollmentAPIKeyRouteService.getDeletePath", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.enrollmentAPIKeyRouteService.getDeletePath.$1", "type": "string", + "tags": [], "label": "keyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 173 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(keyId: string) => string" - ], - "description": [], - "label": "getDeletePath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 173 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "enrollmentAPIKeyRouteService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 169 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES", "type": "Object", "tags": [], + "label": "EPM_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.BULK_INSTALL_PATTERN", "type": "string", + "tags": [], "label": "BULK_INSTALL_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.LIST_PATTERN", "type": "string", + "tags": [], "label": "LIST_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 26 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.LIMITED_LIST_PATTERN", "type": "string", + "tags": [], "label": "LIMITED_LIST_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 27 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.INFO_PATTERN", "type": "string", + "tags": [], "label": "INFO_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 28 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN", "type": "string", + "tags": [], "label": "INSTALL_FROM_REGISTRY_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 29 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.INSTALL_BY_UPLOAD_PATTERN", "type": "string", + "tags": [], "label": "INSTALL_BY_UPLOAD_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.DELETE_PATTERN", "type": "string", + "tags": [], "label": "DELETE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.FILEPATH_PATTERN", "type": "string", + "tags": [], "label": "FILEPATH_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.CATEGORIES_PATTERN", "type": "string", + "tags": [], "label": "CATEGORIES_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 33 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.STATS_PATTERN", "type": "string", + "tags": [], "label": "STATS_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 34 - } + }, + "deprecated": false } ], - "description": [], - "label": "EPM_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.epmRouteService", "type": "Object", "tags": [], + "label": "epmRouteService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getCategoriesPath", "type": "Function", - "children": [], + "tags": [], + "label": "getCategoriesPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getCategoriesPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getListPath", "type": "Function", - "children": [], + "tags": [], + "label": "getListPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getListPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 28 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getListLimitedPath", "type": "Function", - "children": [], + "tags": [], + "label": "getListLimitedPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getListLimitedPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 32 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getInfoPath", "type": "Function", + "tags": [], + "label": "getInfoPath", + "description": [], + "signature": [ + "(pkgkey: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 36 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getInfoPath.$1", "type": "string", + "tags": [], "label": "pkgkey", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(pkgkey: string) => string" - ], - "description": [], - "label": "getInfoPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 36 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getStatsPath", "type": "Function", + "tags": [], + "label": "getStatsPath", + "description": [], + "signature": [ + "(pkgName: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getStatsPath.$1", "type": "string", + "tags": [], "label": "pkgName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 40 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(pkgName: string) => string" - ], - "description": [], - "label": "getStatsPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 40 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getFilePath", "type": "Function", + "tags": [], + "label": "getFilePath", + "description": [], + "signature": [ + "(filePath: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getFilePath.$1", "type": "string", + "tags": [], "label": "filePath", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 44 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(filePath: string) => string" - ], - "description": [], - "label": "getFilePath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 44 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getInstallPath", "type": "Function", + "tags": [], + "label": "getInstallPath", + "description": [], + "signature": [ + "(pkgkey: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getInstallPath.$1", "type": "string", + "tags": [], "label": "pkgkey", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 48 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(pkgkey: string) => string" - ], - "description": [], - "label": "getInstallPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 48 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getBulkInstallPath", "type": "Function", - "children": [], + "tags": [], + "label": "getBulkInstallPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getBulkInstallPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 55 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getRemovePath", "type": "Function", + "tags": [], + "label": "getRemovePath", + "description": [], + "signature": [ + "(pkgkey: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.epmRouteService.getRemovePath.$1", "type": "string", + "tags": [], "label": "pkgkey", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(pkgkey: string) => string" - ], - "description": [], - "label": "getRemovePath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 59 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "epmRouteService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.fleetSetupRouteService", "type": "Object", "tags": [], + "label": "fleetSetupRouteService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 129 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.fleetSetupRouteService.getFleetSetupPath", "type": "Function", - "children": [], + "tags": [], + "label": "getFleetSetupPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getFleetSetupPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 130 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.fleetSetupRouteService.postFleetSetupPath", "type": "Function", - "children": [], + "tags": [], + "label": "postFleetSetupPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "postFleetSetupPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 131 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "description": [], - "label": "fleetSetupRouteService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 129 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.installationStatuses", "type": "Object", + "tags": [], "label": "installationStatuses", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "lineNumber": 32 - }, "signature": [ "{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }" ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 33 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.OUTPUT_API_ROUTES", "type": "Object", "tags": [], + "label": "OUTPUT_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.OUTPUT_API_ROUTES.LIST_PATTERN", "type": "string", + "tags": [], "label": "LIST_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 65 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.OUTPUT_API_ROUTES.INFO_PATTERN", "type": "string", + "tags": [], "label": "INFO_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 66 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.OUTPUT_API_ROUTES.UPDATE_PATTERN", "type": "string", + "tags": [], "label": "UPDATE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 67 - } + }, + "deprecated": false } ], - "description": [], - "label": "OUTPUT_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 64 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.outputRoutesService", "type": "Object", "tags": [], + "label": "outputRoutesService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 152 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.outputRoutesService.getInfoPath", "type": "Function", + "tags": [], + "label": "getInfoPath", + "description": [], + "signature": [ + "(outputId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 153 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.outputRoutesService.getInfoPath.$1", "type": "string", + "tags": [], "label": "outputId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 154 - } + "lineNumber": 153 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.outputRoutesService.getUpdatePath", + "type": "Function", + "tags": [], + "label": "getUpdatePath", + "description": [], "signature": [ "(outputId: string) => string" ], - "description": [], - "label": "getInfoPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 154 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.outputRoutesService.getUpdatePath", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.outputRoutesService.getUpdatePath.$1", "type": "string", + "tags": [], "label": "outputId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 155 - } + "lineNumber": 154 + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(outputId: string) => string" - ], - "description": [], - "label": "getUpdatePath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 155 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.outputRoutesService.getListPath", "type": "Function", - "children": [], + "tags": [], + "label": "getListPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getListPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 157 + "lineNumber": 156 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "description": [], - "label": "outputRoutesService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 153 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.outputType", "type": "Object", + "tags": [], "label": "outputType", "description": [], + "signature": [ + "{ readonly Elasticsearch: \"elasticsearch\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/output.ts", "lineNumber": 12 }, - "signature": [ - "{ readonly Elasticsearch: \"elasticsearch\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PACKAGE_POLICY_API_ROUTES", "type": "Object", "tags": [], + "label": "PACKAGE_POLICY_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 43 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PACKAGE_POLICY_API_ROUTES.LIST_PATTERN", "type": "string", + "tags": [], "label": "LIST_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 44 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PACKAGE_POLICY_API_ROUTES.INFO_PATTERN", "type": "string", + "tags": [], "label": "INFO_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 45 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PACKAGE_POLICY_API_ROUTES.CREATE_PATTERN", "type": "string", + "tags": [], "label": "CREATE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 46 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PACKAGE_POLICY_API_ROUTES.UPDATE_PATTERN", "type": "string", + "tags": [], "label": "UPDATE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 47 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PACKAGE_POLICY_API_ROUTES.DELETE_PATTERN", "type": "string", + "tags": [], "label": "DELETE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 48 - } + }, + "deprecated": false } ], - "description": [], - "label": "PACKAGE_POLICY_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 43 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.packagePolicyRouteService", "type": "Object", "tags": [], + "label": "packagePolicyRouteService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.packagePolicyRouteService.getListPath", "type": "Function", - "children": [], + "tags": [], + "label": "getListPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getListPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 65 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.packagePolicyRouteService.getInfoPath", "type": "Function", + "tags": [], + "label": "getInfoPath", + "description": [], + "signature": [ + "(packagePolicyId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.packagePolicyRouteService.getInfoPath.$1", "type": "string", + "tags": [], "label": "packagePolicyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 69 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(packagePolicyId: string) => string" - ], - "description": [], - "label": "getInfoPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 69 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.packagePolicyRouteService.getCreatePath", "type": "Function", - "children": [], + "tags": [], + "label": "getCreatePath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getCreatePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 73 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.packagePolicyRouteService.getUpdatePath", "type": "Function", + "tags": [], + "label": "getUpdatePath", + "description": [], + "signature": [ + "(packagePolicyId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 77 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.packagePolicyRouteService.getUpdatePath.$1", "type": "string", + "tags": [], "label": "packagePolicyId", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 77 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(packagePolicyId: string) => string" - ], - "description": [], - "label": "getUpdatePath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 77 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.packagePolicyRouteService.getDeletePath", "type": "Function", - "children": [], + "tags": [], + "label": "getDeletePath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getDeletePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 81 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "description": [], - "label": "packagePolicyRouteService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 64 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PRECONFIGURATION_API_ROUTES", "type": "Object", "tags": [], + "label": "PRECONFIGURATION_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 119 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PRECONFIGURATION_API_ROUTES.PUT_PRECONFIG", "type": "string", + "tags": [], "label": "PUT_PRECONFIG", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 125 - } + "lineNumber": 120 + }, + "deprecated": false } ], - "description": [], - "label": "PRECONFIGURATION_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 124 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.requiredPackages", "type": "Object", + "tags": [], "label": "requiredPackages", "description": [], + "signature": [ + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", "lineNumber": 14 }, - "signature": [ - "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.SETTINGS_API_ROUTES", "type": "Object", "tags": [], + "label": "SETTINGS_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.SETTINGS_API_ROUTES.INFO_PATTERN", "type": "string", + "tags": [], "label": "INFO_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 72 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.SETTINGS_API_ROUTES.UPDATE_PATTERN", "type": "string", + "tags": [], "label": "UPDATE_PATTERN", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 73 - } + }, + "deprecated": false } ], - "description": [], - "label": "SETTINGS_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 71 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.settingsRoutesService", "type": "Object", "tags": [], + "label": "settingsRoutesService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 159 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.settingsRoutesService.getInfoPath", "type": "Function", - "children": [], + "tags": [], + "label": "getInfoPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getInfoPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 161 + "lineNumber": 160 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.settingsRoutesService.getUpdatePath", "type": "Function", - "children": [], + "tags": [], + "label": "getUpdatePath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getUpdatePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 162 + "lineNumber": 161 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "description": [], - "label": "settingsRoutesService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 160 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.setupRouteService", "type": "Object", "tags": [], + "label": "setupRouteService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 177 + }, + "deprecated": false, "children": [ { + "parentPluginId": "fleet", "id": "def-common.setupRouteService.getSetupPath", "type": "Function", - "children": [], + "tags": [], + "label": "getSetupPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getSetupPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 178 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "description": [], - "label": "setupRouteService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 177 - }, "initialIsOpen": false } ] diff --git a/api_docs/global_search.json b/api_docs/global_search.json index 25bdddff95616..e0db9993b8597 100644 --- a/api_docs/global_search.json +++ b/api_docs/global_search.json @@ -5,168 +5,189 @@ "functions": [], "interfaces": [ { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchBatchedResults", "type": "Interface", + "tags": [], "label": "GlobalSearchBatchedResults", "description": [ "\nResponse returned from the {@link GlobalSearchPluginStart | global search service}'s `find` API\n" ], - "tags": [ - "public" - ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 85 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchBatchedResults.results", "type": "Array", + "tags": [], "label": "results", "description": [ "\nResults for this batch" ], + "signature": [ + "GlobalSearchResult", + "[]" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 89 }, - "signature": [ - "GlobalSearchResult", - "[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/common/types.ts", - "lineNumber": 85 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchFindOptions", "type": "Interface", + "tags": [], "label": "GlobalSearchFindOptions", "description": [ "\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}" ], - "tags": [], + "source": { + "path": "x-pack/plugins/global_search/public/services/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchFindOptions.preference", "type": "string", + "tags": [], "label": "preference", "description": [ "\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster.\n\nIf not specified, a random token will be generated and used. The token is stored in the sessionStorage and is guaranteed\nto be consistent during a given http 'session'" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/global_search/public/services/types.ts", "lineNumber": 22 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchFindOptions.aborted$", "type": "Object", + "tags": [], "label": "aborted$", "description": [ "\nOptional observable to notify that the associated `find` call should be canceled.\nIf/when provided and emitting, the result observable will be completed and no further result emission will be performed." ], + "signature": [ + "Observable", + " | undefined" + ], "source": { "path": "x-pack/plugins/global_search/public/services/types.ts", "lineNumber": 27 }, - "signature": [ - "Observable", - " | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/public/services/types.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchFindParams", "type": "Interface", + "tags": [], "label": "GlobalSearchFindParams", "description": [ "\nSearch parameters for the {@link GlobalSearchPluginStart.find | `find` API}\n" ], - "tags": [ - "public" - ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 97 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchFindParams.term", "type": "string", + "tags": [], "label": "term", "description": [ "\nThe term to search for. Can be undefined if searching by filters." ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 101 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchFindParams.types", "type": "Array", + "tags": [], "label": "types", "description": [ "\nThe types of results to search for." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 105 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchFindParams.tags", "type": "Array", + "tags": [], "label": "tags", "description": [ "\nThe tag ids to filter search by." ], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 109 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/common/types.ts", - "lineNumber": 97 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderFindOptions", "type": "Interface", + "tags": [], "label": "GlobalSearchProviderFindOptions", "description": [ "\nOptions provided to {@link GlobalSearchResultProvider | a result provider}'s `find` method." ], - "tags": [], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderFindOptions.preference", "type": "string", + "tags": [], "label": "preference", "description": [ "\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster." @@ -174,29 +195,33 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderFindOptions.aborted$", "type": "Object", + "tags": [], "label": "aborted$", "description": [ "\nObservable that emits once if and when the `find` call has been aborted, either manually by the consumer,\nor when the internal timeout period as been reached.\n\nWhen a `find` request is effectively aborted, the service will stop emitting any new result to the consumer anyway, but\nthis can (and should) be used to cancel any pending asynchronous task and complete the result observable from within the provider." ], + "signature": [ + "Observable", + "" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 28 }, - "signature": [ - "Observable", - "" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderFindOptions.maxResults", "type": "number", + "tags": [], "label": "maxResults", "description": [ "\nThe total maximum number of results (including all batches, not per emission) that should be returned by the provider for a given `find` request.\nAny result emitted exceeding this quota will be ignored by the service and not emitted to the consumer." @@ -204,28 +229,32 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 33 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/common/types.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderResult", "type": "Interface", + "tags": [], "label": "GlobalSearchProviderResult", "description": [ "\nRepresentation of a result returned by a {@link GlobalSearchResultProvider | result provider}" ], - "tags": [], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderResult.id", "type": "string", + "tags": [], "label": "id", "description": [ "an id that should be unique for an individual provider's results" @@ -233,12 +262,14 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 46 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderResult.title", "type": "string", + "tags": [], "label": "title", "description": [ "the title/label of the result" @@ -246,12 +277,14 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 48 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderResult.type", "type": "string", + "tags": [], "label": "type", "description": [ "the type of result" @@ -259,44 +292,50 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 50 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderResult.icon", "type": "string", + "tags": [], "label": "icon", "description": [ "an optional EUI icon name to associate with the search result" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 52 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderResult.url", "type": "CompoundType", + "tags": [], "label": "url", "description": [ "\nThe url associated with this result.\nThis can be either an absolute url, a path relative to the incoming request's basePath, or a structure specifying if the basePath should be prepended.\n" ], + "signature": [ + "GlobalSearchProviderResultUrl" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 62 }, - "signature": [ - "GlobalSearchProviderResultUrl" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderResult.score", "type": "number", + "tags": [], "label": "score", "description": [ "the score of the result, from 1 (lowest) to 100 (highest)" @@ -304,46 +343,52 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 64 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderResult.meta", "type": "Object", + "tags": [], "label": "meta", "description": [ "an optional record of metadata for this result" ], - "source": { - "path": "x-pack/plugins/global_search/common/types.ts", - "lineNumber": 66 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 66 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/common/types.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchResultProvider", "type": "Interface", + "tags": [], "label": "GlobalSearchResultProvider", "description": [ "\nGlobalSearch result provider, to be registered using the {@link GlobalSearchPluginSetup | global search API}" ], - "tags": [], + "source": { + "path": "x-pack/plugins/global_search/public/types.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchResultProvider.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nid of the provider" @@ -351,12 +396,18 @@ "source": { "path": "x-pack/plugins/global_search/public/types.ts", "lineNumber": 26 - } + }, + "deprecated": false }, { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchResultProvider.find", "type": "Function", + "tags": [], "label": "find", + "description": [ + "\nMethod that should return an observable used to emit new results from the provider.\n\nSee {@GlobalSearchProviderResult | the result type} for the expected result structure.\n" + ], "signature": [ "(search: ", "GlobalSearchFindParams", @@ -368,151 +419,155 @@ "GlobalSearchProviderResult", "[]>" ], - "description": [ - "\nMethod that should return an observable used to emit new results from the provider.\n\nSee {@GlobalSearchProviderResult | the result type} for the expected result structure.\n" - ], + "source": { + "path": "x-pack/plugins/global_search/public/types.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchResultProvider.find.$1", "type": "Object", + "tags": [], "label": "search", - "isRequired": true, + "description": [], "signature": [ "GlobalSearchFindParams" ], - "description": [], "source": { "path": "x-pack/plugins/global_search/public/types.ts", "lineNumber": 45 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchResultProvider.find.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ "GlobalSearchProviderFindOptions" ], - "description": [], "source": { "path": "x-pack/plugins/global_search/public/types.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/global_search/public/types.ts", - "lineNumber": 44 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchResultProvider.getSearchableTypes", "type": "Function", + "tags": [], "label": "getSearchableTypes", "description": [ "\nMethod that should return all the possible {@link GlobalSearchProviderResult.type | type} of results that\nthis provider can return." ], + "signature": [ + "() => string[] | Promise" + ], "source": { "path": "x-pack/plugins/global_search/public/types.ts", "lineNumber": 53 }, - "signature": [ - "() => string[] | Promise" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/public/types.ts", - "lineNumber": 22 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderFindParams", "type": "Type", + "tags": [], "label": "GlobalSearchProviderFindParams", - "tags": [ - "public" - ], "description": [], + "signature": [ + "GlobalSearchFindParams" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 115 }, - "signature": [ - "GlobalSearchFindParams" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchProviderResultUrl", "type": "Type", - "label": "GlobalSearchProviderResultUrl", "tags": [], + "label": "GlobalSearchProviderResultUrl", "description": [ "\nStructured type for the {@link GlobalSearchProviderResult.url | provider result's url property}" ], + "signature": [ + "string | { path: string; prependBasePath: boolean; }" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 39 }, - "signature": [ - "string | { path: string; prependBasePath: boolean; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchResult", "type": "Type", - "label": "GlobalSearchResult", "tags": [], + "label": "GlobalSearchResult", "description": [ "\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}" ], + "signature": [ + "Pick & { url: string; }" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 72 }, - "signature": [ - "Pick & { url: string; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchPluginSetup", "type": "Type", - "label": "GlobalSearchPluginSetup", "tags": [], + "label": "GlobalSearchPluginSetup", "description": [], + "signature": [ + "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" + ], "source": { "path": "x-pack/plugins/global_search/public/types.ts", "lineNumber": 16 }, - "signature": [ - "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" - ], + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "globalSearch", "id": "def-public.GlobalSearchPluginStart", "type": "Type", - "label": "GlobalSearchPluginStart", "tags": [], + "label": "GlobalSearchPluginStart", "description": [], - "source": { - "path": "x-pack/plugins/global_search/public/types.ts", - "lineNumber": 17 - }, "signature": [ "{ find: (params: ", "GlobalSearchFindParams", @@ -528,6 +583,11 @@ "GlobalSearchBatchedResults", ">; getSearchableTypes: () => Promise; }" ], + "source": { + "path": "x-pack/plugins/global_search/public/types.ts", + "lineNumber": 17 + }, + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -537,112 +597,119 @@ "functions": [], "interfaces": [ { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchBatchedResults", "type": "Interface", + "tags": [], "label": "GlobalSearchBatchedResults", "description": [ "\nResponse returned from the {@link GlobalSearchPluginStart | global search service}'s `find` API\n" ], - "tags": [ - "public" - ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 85 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchBatchedResults.results", "type": "Array", + "tags": [], "label": "results", "description": [ "\nResults for this batch" ], + "signature": [ + "GlobalSearchResult", + "[]" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 89 }, - "signature": [ - "GlobalSearchResult", - "[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/common/types.ts", - "lineNumber": 85 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchFindOptions", "type": "Interface", + "tags": [], "label": "GlobalSearchFindOptions", "description": [ "\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}\n" ], - "tags": [ - "public" - ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 88 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchFindOptions.preference", "type": "string", + "tags": [], "label": "preference", "description": [ "\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster.\nIf not specified, a random token will be generated and used." ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 95 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchFindOptions.aborted$", "type": "Object", + "tags": [], "label": "aborted$", "description": [ "\nOptional observable to notify that the associated `find` call should be canceled.\nIf/when provided and emitting, no further result emission will be performed and the result observable will be completed." ], + "signature": [ + "Observable", + " | undefined" + ], "source": { "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 100 }, - "signature": [ - "Observable", - " | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/server/types.ts", - "lineNumber": 88 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderContext", "type": "Interface", + "tags": [], "label": "GlobalSearchProviderContext", "description": [ "\nContext passed to server-side {@GlobalSearchResultProvider | result provider}'s `find` method.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 65 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderContext.core", "type": "Object", + "tags": [], "label": "core", "description": [], - "source": { - "path": "x-pack/plugins/global_search/server/types.ts", - "lineNumber": 66 - }, "signature": [ "{ savedObjects: { client: Pick<", { @@ -678,28 +745,36 @@ }, "; }; capabilities: ", "Observable" - ] + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 66 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/server/types.ts", - "lineNumber": 65 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderFindOptions", "type": "Interface", + "tags": [], "label": "GlobalSearchProviderFindOptions", "description": [ "\nOptions provided to {@link GlobalSearchResultProvider | a result provider}'s `find` method." ], - "tags": [], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderFindOptions.preference", "type": "string", + "tags": [], "label": "preference", "description": [ "\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster." @@ -707,29 +782,33 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderFindOptions.aborted$", "type": "Object", + "tags": [], "label": "aborted$", "description": [ "\nObservable that emits once if and when the `find` call has been aborted, either manually by the consumer,\nor when the internal timeout period as been reached.\n\nWhen a `find` request is effectively aborted, the service will stop emitting any new result to the consumer anyway, but\nthis can (and should) be used to cancel any pending asynchronous task and complete the result observable from within the provider." ], + "signature": [ + "Observable", + "" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 28 }, - "signature": [ - "Observable", - "" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderFindOptions.maxResults", "type": "number", + "tags": [], "label": "maxResults", "description": [ "\nThe total maximum number of results (including all batches, not per emission) that should be returned by the provider for a given `find` request.\nAny result emitted exceeding this quota will be ignored by the service and not emitted to the consumer." @@ -737,28 +816,32 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 33 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/common/types.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderResult", "type": "Interface", + "tags": [], "label": "GlobalSearchProviderResult", "description": [ "\nRepresentation of a result returned by a {@link GlobalSearchResultProvider | result provider}" ], - "tags": [], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderResult.id", "type": "string", + "tags": [], "label": "id", "description": [ "an id that should be unique for an individual provider's results" @@ -766,12 +849,14 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 46 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderResult.title", "type": "string", + "tags": [], "label": "title", "description": [ "the title/label of the result" @@ -779,12 +864,14 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 48 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderResult.type", "type": "string", + "tags": [], "label": "type", "description": [ "the type of result" @@ -792,44 +879,50 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 50 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderResult.icon", "type": "string", + "tags": [], "label": "icon", "description": [ "an optional EUI icon name to associate with the search result" ], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 52 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderResult.url", "type": "CompoundType", + "tags": [], "label": "url", "description": [ "\nThe url associated with this result.\nThis can be either an absolute url, a path relative to the incoming request's basePath, or a structure specifying if the basePath should be prepended.\n" ], + "signature": [ + "GlobalSearchProviderResultUrl" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 62 }, - "signature": [ - "GlobalSearchProviderResultUrl" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderResult.score", "type": "number", + "tags": [], "label": "score", "description": [ "the score of the result, from 1 (lowest) to 100 (highest)" @@ -837,48 +930,52 @@ "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 64 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderResult.meta", "type": "Object", + "tags": [], "label": "meta", "description": [ "an optional record of metadata for this result" ], - "source": { - "path": "x-pack/plugins/global_search/common/types.ts", - "lineNumber": 66 - }, "signature": [ "Record | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 66 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/common/types.ts", - "lineNumber": 44 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchResultProvider", "type": "Interface", + "tags": [], "label": "GlobalSearchResultProvider", "description": [ "\nGlobalSearch result provider, to be registered using the {@link GlobalSearchPluginSetup | global search API}\n" ], - "tags": [ - "public" - ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 108 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchResultProvider.id", "type": "string", + "tags": [], "label": "id", "description": [ "\nid of the provider" @@ -886,12 +983,18 @@ "source": { "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 112 - } + }, + "deprecated": false }, { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchResultProvider.find", "type": "Function", + "tags": [], "label": "find", + "description": [ + "\nMethod that should return an observable used to emit new results from the provider.\n\nSee {@GlobalSearchProviderResult | the result type} for the expected result structure.\n" + ], "signature": [ "(search: ", "GlobalSearchFindParams", @@ -910,43 +1013,53 @@ "<", "GlobalSearchProviderResult" ], - "description": [ - "\nMethod that should return an observable used to emit new results from the provider.\n\nSee {@GlobalSearchProviderResult | the result type} for the expected result structure.\n" - ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 130 + }, + "deprecated": false, "children": [ { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchResultProvider.find.$1", "type": "Object", + "tags": [], "label": "search", - "isRequired": true, + "description": [], "signature": [ "GlobalSearchFindParams" ], - "description": [], "source": { "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 131 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchResultProvider.find.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ "GlobalSearchProviderFindOptions" ], - "description": [], "source": { "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 132 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchResultProvider.find.$3", "type": "Object", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "globalSearch", @@ -956,32 +1069,25 @@ "text": "GlobalSearchProviderContext" } ], - "description": [], "source": { "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 133 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/global_search/server/types.ts", - "lineNumber": 130 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchResultProvider.getSearchableTypes", "type": "Function", + "tags": [], "label": "getSearchableTypes", "description": [ "\nMethod that should return all the possible {@link GlobalSearchProviderResult.type | type} of results that\nthis provider can return." ], - "source": { - "path": "x-pack/plugins/global_search/server/types.ts", - "lineNumber": 140 - }, "signature": [ "(context: ", { @@ -992,30 +1098,40 @@ "text": "GlobalSearchProviderContext" }, ") => string[] | Promise" - ] + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 140 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/server/types.ts", - "lineNumber": 108 - }, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-server.RouteHandlerGlobalSearchContext", "type": "Interface", + "tags": [], "label": "RouteHandlerGlobalSearchContext", "description": [ "\nglobalSearch route handler context.\n" ], - "tags": [ - "public" - ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { + "parentPluginId": "globalSearch", "id": "def-server.RouteHandlerGlobalSearchContext.find", "type": "Function", + "tags": [], "label": "find", + "description": [ + "\nSee {@link SearchServiceStart.find | the find API}" + ], "signature": [ "(params: ", "GlobalSearchFindParams", @@ -1033,29 +1149,36 @@ "GlobalSearchBatchedResults", ">" ], - "description": [ - "\nSee {@link SearchServiceStart.find | the find API}" - ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 50 + }, + "deprecated": false, "children": [ { + "parentPluginId": "globalSearch", "id": "def-server.RouteHandlerGlobalSearchContext.find.$1", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "GlobalSearchFindParams" ], - "description": [], "source": { "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 51 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "globalSearch", "id": "def-server.RouteHandlerGlobalSearchContext.find.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "globalSearch", @@ -1065,92 +1188,87 @@ "text": "GlobalSearchFindOptions" } ], - "description": [], "source": { "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 52 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/global_search/server/types.ts", - "lineNumber": 50 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "globalSearch", "id": "def-server.RouteHandlerGlobalSearchContext.getSearchableTypes", "type": "Function", + "tags": [], "label": "getSearchableTypes", "description": [ "\nSee {@link SearchServiceStart.getSearchableTypes | the getSearchableTypes API}" ], + "signature": [ + "() => Promise" + ], "source": { "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 57 }, - "signature": [ - "() => Promise" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/global_search/server/types.ts", - "lineNumber": 46 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchProviderResultUrl", "type": "Type", - "label": "GlobalSearchProviderResultUrl", "tags": [], + "label": "GlobalSearchProviderResultUrl", "description": [ "\nStructured type for the {@link GlobalSearchProviderResult.url | provider result's url property}" ], + "signature": [ + "string | { path: string; prependBasePath: boolean; }" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 39 }, - "signature": [ - "string | { path: string; prependBasePath: boolean; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchResult", "type": "Type", - "label": "GlobalSearchResult", "tags": [], + "label": "GlobalSearchResult", "description": [ "\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}" ], + "signature": [ + "Pick & { url: string; }" + ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", "lineNumber": 72 }, - "signature": [ - "Pick & { url: string; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "start": { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchPluginStart", "type": "Type", - "label": "GlobalSearchPluginStart", "tags": [], + "label": "GlobalSearchPluginStart", "description": [], - "source": { - "path": "x-pack/plugins/global_search/server/types.ts", - "lineNumber": 28 - }, "signature": [ "{ find: (params: GlobalSearchFindParams, options: GlobalSearchFindOptions, request: ", { @@ -1170,22 +1288,29 @@ }, ") => Promise; }" ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 28 + }, + "deprecated": false, "lifecycle": "start", "initialIsOpen": true }, "setup": { + "parentPluginId": "globalSearch", "id": "def-server.GlobalSearchPluginSetup", "type": "Type", - "label": "GlobalSearchPluginSetup", "tags": [], + "label": "GlobalSearchPluginSetup", "description": [], + "signature": [ + "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" + ], "source": { "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 27 }, - "signature": [ - "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" - ], + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true } diff --git a/api_docs/home.json b/api_docs/home.json index 4e9ab0466f91e..55d93aaf19def 100644 --- a/api_docs/home.json +++ b/api_docs/home.json @@ -4,59 +4,69 @@ "classes": [], "functions": [ { + "parentPluginId": "home", "id": "def-public.getDisplayText", "type": "Function", - "label": "getDisplayText", - "signature": [ - "(id: \"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\") => string" + "tags": [ + "params", + "return" ], + "label": "getDisplayText", "description": [ "\nConvert instruction variant id into display text.\n" ], + "signature": [ + "(id: \"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\") => string" + ], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { + "parentPluginId": "home", "id": "def-public.getDisplayText.$1", "type": "CompoundType", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "\"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\"" ], - "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 55 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "params", - "return" - ], "returnComment": [ "display name" ], - "source": { - "path": "src/plugins/home/common/instruction_variant.ts", - "lineNumber": 55 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "home", "id": "def-public.Environment", "type": "Interface", + "tags": [], "label": "Environment", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/home/public/services/environment/environment.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "home", "id": "def-public.Environment.cloud", "type": "boolean", + "tags": [], "label": "cloud", "description": [ "\nFlag whether the home app should advertise cloud features" @@ -64,12 +74,14 @@ "source": { "path": "src/plugins/home/public/services/environment/environment.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.Environment.apmUi", "type": "boolean", + "tags": [], "label": "apmUi", "description": [ "\nFlag whether the home app should advertise apm features" @@ -77,12 +89,14 @@ "source": { "path": "src/plugins/home/public/services/environment/environment.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.Environment.ml", "type": "boolean", + "tags": [], "label": "ml", "description": [ "\nFlag whether the home app should advertise ml features" @@ -90,28 +104,30 @@ "source": { "path": "src/plugins/home/public/services/environment/environment.ts", "lineNumber": 22 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/home/public/services/environment/environment.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry", "type": "Interface", + "tags": [], "label": "FeatureCatalogueEntry", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.id", "type": "string", + "tags": [], "label": "id", "description": [ "Unique string identifier for this feature." @@ -119,12 +135,14 @@ "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.title", "type": "string", + "tags": [], "label": "title", "description": [ "Title of feature displayed to the user." @@ -132,20 +150,18 @@ "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.category", "type": "Enum", + "tags": [], "label": "category", "description": [ "{@link FeatureCatalogueCategory} to display this feature in." ], - "source": { - "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", - "lineNumber": 26 - }, "signature": [ { "pluginId": "home", @@ -154,28 +170,36 @@ "section": "def-public.FeatureCatalogueCategory", "text": "FeatureCatalogueCategory" } - ] + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 26 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.subtitle", "type": "string", + "tags": [], "label": "subtitle", "description": [ "A tagline of feature displayed to the user." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 28 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.description", "type": "string", + "tags": [], "label": "description", "description": [ "One-line description of feature displayed to the user." @@ -183,28 +207,32 @@ "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.icon", "type": "CompoundType", + "tags": [], "label": "icon", "description": [ "EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement." ], + "signature": [ + "IconType" + ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 32 }, - "signature": [ - "IconType" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.path", "type": "string", + "tags": [], "label": "path", "description": [ "URL path to link to this future. Should not include the basePath." @@ -212,12 +240,14 @@ "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 34 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.showOnHomePage", "type": "boolean", + "tags": [], "label": "showOnHomePage", "description": [ "Whether or not this link should be shown on the front page of Kibana." @@ -225,76 +255,84 @@ "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 36 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.order", "type": "number", + "tags": [], "label": "order", "description": [ "An ordinal used to sort features relative to one another for display on the home page" ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 38 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.visible", "type": "Function", + "tags": [], "label": "visible", "description": [ "Optional function to control visibility of this feature." ], + "signature": [ + "(() => boolean) | undefined" + ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 40 }, - "signature": [ - "(() => boolean) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.solutionId", "type": "string", + "tags": [], "label": "solutionId", "description": [ "Unique string identifier of the solution this feature belongs to" ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 42 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution", "type": "Interface", + "tags": [], "label": "FeatureCatalogueSolution", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.id", "type": "string", + "tags": [], "label": "id", "description": [ "Unique string identifier for this solution." @@ -302,12 +340,14 @@ "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 48 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.title", "type": "string", + "tags": [], "label": "title", "description": [ "Title of solution displayed to the user." @@ -315,12 +355,14 @@ "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 50 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.subtitle", "type": "string", + "tags": [], "label": "subtitle", "description": [ "The tagline of the solution displayed to the user." @@ -328,60 +370,68 @@ "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 52 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.description", "type": "string", + "tags": [], "label": "description", "description": [ "One-line description of the solution displayed to the user." ], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 54 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.appDescriptions", "type": "Array", + "tags": [], "label": "appDescriptions", "description": [ "A list of use cases for this solution displayed to the user." ], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 56 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.icon", "type": "CompoundType", + "tags": [], "label": "icon", "description": [ "EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement." ], + "signature": [ + "IconType" + ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 58 }, - "signature": [ - "IconType" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.path", "type": "string", + "tags": [], "label": "path", "description": [ "URL path to link to this future. Should not include the basePath." @@ -389,61 +439,55 @@ "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 60 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.order", "type": "number", + "tags": [], "label": "order", "description": [ "An ordinal used to sort solutions relative to one another for display on the home page" ], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 62 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", - "lineNumber": 46 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "home", "id": "def-public.FeatureCatalogueCategory", "type": "Enum", + "tags": [], "label": "FeatureCatalogueCategory", - "tags": [ - "public" - ], "description": [], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "lineNumber": 13 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "home", "id": "def-public.EnvironmentSetup", "type": "Type", + "tags": [], "label": "EnvironmentSetup", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 161 - }, "signature": [ "{ update: (update: Partial<", { @@ -455,20 +499,20 @@ }, ">) => void; }" ], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 161 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "home", "id": "def-public.FeatureCatalogueSetup", "type": "Type", + "tags": [], "label": "FeatureCatalogueSetup", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 158 - }, "signature": [ "{ register: (feature: ", { @@ -488,71 +532,71 @@ }, ") => void; }" ], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 158 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "home", "id": "def-public.TutorialDirectoryHeaderLinkComponent", "type": "Type", + "tags": [], "label": "TutorialDirectoryHeaderLinkComponent", - "tags": [ - "public" - ], "description": [], + "signature": [ + "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" + ], "source": { "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", "lineNumber": 18 }, - "signature": [ - "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "home", "id": "def-public.TutorialDirectoryNoticeComponent", "type": "Type", + "tags": [], "label": "TutorialDirectoryNoticeComponent", - "tags": [ - "public" - ], "description": [], + "signature": [ + "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" + ], "source": { "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", "lineNumber": 15 }, - "signature": [ - "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "home", "id": "def-public.TutorialModuleNoticeComponent", "type": "Type", + "tags": [], "label": "TutorialModuleNoticeComponent", - "tags": [ - "public" - ], "description": [], + "signature": [ + "(props: React.PropsWithChildren<{ moduleName: string; }>, context: any) => React.ReactElement | null" + ], "source": { "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", "lineNumber": 21 }, - "signature": [ - "(props: React.PropsWithChildren<{ moduleName: string; }>, context: any) => React.ReactElement | null" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "home", "id": "def-public.TutorialSetup", "type": "Type", + "tags": [], "label": "TutorialSetup", - "tags": [ - "public" - ], "description": [], - "source": { - "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 164 - }, "signature": [ "{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: ", "FC", @@ -562,262 +606,306 @@ "FC", "<{ moduleName: string; }>) => void; }" ], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 164 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "home", "id": "def-public.TutorialVariables", "type": "Type", + "tags": [], "label": "TutorialVariables", - "tags": [ - "public" - ], "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], "source": { "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", "lineNumber": 12 }, - "signature": [ - "{ [x: string]: unknown; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT", "type": "Object", "tags": [], - "children": [ - { - "tags": [], + "label": "INSTRUCTION_VARIANT", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 9 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.ESC", "type": "string", + "tags": [], "label": "ESC", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 10 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.OSX", "type": "string", + "tags": [], "label": "OSX", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 11 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.DEB", "type": "string", + "tags": [], "label": "DEB", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.RPM", "type": "string", + "tags": [], "label": "RPM", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.DOCKER", "type": "string", + "tags": [], "label": "DOCKER", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.WINDOWS", "type": "string", + "tags": [], "label": "WINDOWS", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.NODE", "type": "string", + "tags": [], "label": "NODE", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.DJANGO", "type": "string", + "tags": [], "label": "DJANGO", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.FLASK", "type": "string", + "tags": [], "label": "FLASK", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.RAILS", "type": "string", + "tags": [], "label": "RAILS", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.RACK", "type": "string", + "tags": [], "label": "RACK", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.JS", "type": "string", + "tags": [], "label": "JS", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.GO", "type": "string", + "tags": [], "label": "GO", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.JAVA", "type": "string", + "tags": [], "label": "JAVA", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.DOTNET", "type": "string", + "tags": [], "label": "DOTNET", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.LINUX", "type": "string", + "tags": [], "label": "LINUX", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.PHP", "type": "string", + "tags": [], "label": "PHP", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 26 - } + }, + "deprecated": false } ], - "description": [], - "label": "INSTRUCTION_VARIANT", - "source": { - "path": "src/plugins/home/common/instruction_variant.ts", - "lineNumber": 9 - }, "initialIsOpen": false } ], "setup": { + "parentPluginId": "home", "id": "def-public.HomePublicPluginSetup", "type": "Interface", + "tags": [], "label": "HomePublicPluginSetup", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 167 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "home", "id": "def-public.HomePublicPluginSetup.tutorials", "type": "Object", + "tags": [], "label": "tutorials", "description": [], + "signature": [ + "{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: React.FC<{}>) => void; registerDirectoryHeaderLink: (id: string, component: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; }" + ], "source": { "path": "src/plugins/home/public/plugin.ts", "lineNumber": 168 }, - "signature": [ - "{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: React.FC<{}>) => void; registerDirectoryHeaderLink: (id: string, component: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-public.HomePublicPluginSetup.featureCatalogue", "type": "Object", + "tags": [], "label": "featureCatalogue", "description": [], - "source": { - "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 169 - }, "signature": [ "{ register: (feature: ", { @@ -836,22 +924,24 @@ "text": "FeatureCatalogueSolution" }, ") => void; }" - ] + ], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 169 + }, + "deprecated": false }, { + "parentPluginId": "home", + "id": "def-public.HomePublicPluginSetup.environment", + "type": "Object", "tags": [ "deprecated" ], - "id": "def-public.HomePublicPluginSetup.environment", - "type": "Object", "label": "environment", "description": [ "\nThe environment service is only available for a transition period and will\nbe replaced by display specific extension points." ], - "source": { - "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 176 - }, "signature": [ "{ update: (update: Partial<", { @@ -862,42 +952,70 @@ "text": "Environment" }, ">) => void; }" + ], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 176 + }, + "deprecated": true, + "references": [ + { + "plugin": "cloud", + "link": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 67 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/public/register_feature.ts", + "lineNumber": 18 + } + }, + { + "plugin": "apm", + "link": { + "path": "x-pack/plugins/apm/public/plugin.ts", + "lineNumber": 86 + } + } ] } ], - "source": { - "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 167 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "home", "id": "def-public.HomePublicPluginStart", "type": "Interface", + "tags": [], "label": "HomePublicPluginStart", "description": [], - "tags": [], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 178 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "home", "id": "def-public.HomePublicPluginStart.featureCatalogue", "type": "Object", + "tags": [], "label": "featureCatalogue", "description": [], + "signature": [ + "FeatureCatalogueRegistry" + ], "source": { "path": "src/plugins/home/public/plugin.ts", "lineNumber": 179 }, - "signature": [ - "FeatureCatalogueRegistry" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 178 - }, "lifecycle": "start", "initialIsOpen": true } @@ -907,355 +1025,404 @@ "functions": [], "interfaces": [ { + "parentPluginId": "home", "id": "def-server.ArtifactsSchema", "type": "Interface", + "tags": [], "label": "ArtifactsSchema", "description": [], - "tags": [], + "source": { + "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "home", "id": "def-server.ArtifactsSchema.exportedFields", "type": "Object", + "tags": [], "label": "exportedFields", "description": [], + "signature": [ + "{ documentationUrl: string; } | undefined" + ], "source": { "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "lineNumber": 60 }, - "signature": [ - "{ documentationUrl: string; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.ArtifactsSchema.dashboards", "type": "Array", + "tags": [], "label": "dashboards", "description": [], + "signature": [ + "DashboardSchema", + "[]" + ], "source": { "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "lineNumber": 63 }, - "signature": [ - "DashboardSchema", - "[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.ArtifactsSchema.application", "type": "Object", + "tags": [], "label": "application", "description": [], + "signature": [ + "{ path: string; label: string; } | undefined" + ], "source": { "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "lineNumber": 64 }, - "signature": [ - "{ path: string; label: string; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", - "lineNumber": 59 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "home", "id": "def-server.TutorialsCategory", "type": "Enum", + "tags": [], "label": "TutorialsCategory", - "tags": [ - "public" - ], "description": [], "source": { "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "lineNumber": 13 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "home", "id": "def-server.SampleDataRegistrySetup", "type": "Type", + "tags": [], "label": "SampleDataRegistrySetup", - "tags": [ - "public" - ], "description": [], + "signature": [ + "{ registerSampleDataset: (specProvider: SampleDatasetProvider) => void; getSampleDatasets: () => SampleDatasetSchema[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: SavedObject[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: AppLinkSchema[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: SampleDatasetDashboardPanel) => void; }" + ], "source": { "path": "src/plugins/home/server/services/sample_data/sample_data_registry.ts", "lineNumber": 168 }, - "signature": [ - "{ registerSampleDataset: (specProvider: SampleDatasetProvider) => void; getSampleDatasets: () => SampleDatasetSchema[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: SavedObject[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: AppLinkSchema[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: SampleDatasetDashboardPanel) => void; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "home", "id": "def-server.SampleDatasetProvider", "type": "Type", - "label": "SampleDatasetProvider", "tags": [], + "label": "SampleDatasetProvider", "description": [], - "source": { - "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", - "lineNumber": 82 - }, "signature": [ "() => ", "SampleDatasetSchema", "" ], + "source": { + "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", + "lineNumber": 82 + }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "home", "id": "def-server.TutorialProvider", "type": "Type", - "label": "TutorialProvider", "tags": [], + "label": "TutorialProvider", "description": [], - "source": { - "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", - "lineNumber": 100 - }, "signature": [ "(context: ", "TutorialContext", ") => ", "TutorialSchema" ], + "source": { + "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", + "lineNumber": 100 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT", "type": "Object", "tags": [], + "label": "INSTRUCTION_VARIANT", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.ESC", "type": "string", + "tags": [], "label": "ESC", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 10 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.OSX", "type": "string", + "tags": [], "label": "OSX", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 11 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.DEB", "type": "string", + "tags": [], "label": "DEB", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 12 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.RPM", "type": "string", + "tags": [], "label": "RPM", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 13 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.DOCKER", "type": "string", + "tags": [], "label": "DOCKER", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 14 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.WINDOWS", "type": "string", + "tags": [], "label": "WINDOWS", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.NODE", "type": "string", + "tags": [], "label": "NODE", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 16 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.DJANGO", "type": "string", + "tags": [], "label": "DJANGO", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.FLASK", "type": "string", + "tags": [], "label": "FLASK", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.RAILS", "type": "string", + "tags": [], "label": "RAILS", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.RACK", "type": "string", + "tags": [], "label": "RACK", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 20 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.JS", "type": "string", + "tags": [], "label": "JS", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 21 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.GO", "type": "string", + "tags": [], "label": "GO", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 22 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.JAVA", "type": "string", + "tags": [], "label": "JAVA", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.DOTNET", "type": "string", + "tags": [], "label": "DOTNET", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.LINUX", "type": "string", + "tags": [], "label": "LINUX", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 25 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.PHP", "type": "string", + "tags": [], "label": "PHP", "description": [], "source": { "path": "src/plugins/home/common/instruction_variant.ts", "lineNumber": 26 - } + }, + "deprecated": false } ], - "description": [], - "label": "INSTRUCTION_VARIANT", - "source": { - "path": "src/plugins/home/common/instruction_variant.ts", - "lineNumber": 9 - }, "initialIsOpen": false } ], "setup": { + "parentPluginId": "home", "id": "def-server.HomeServerPluginSetup", "type": "Interface", + "tags": [], "label": "HomeServerPluginSetup", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/home/server/plugin.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "home", "id": "def-server.HomeServerPluginSetup.tutorials", "type": "Object", + "tags": [], "label": "tutorials", "description": [], - "source": { - "path": "src/plugins/home/server/plugin.ts", - "lineNumber": 55 - }, "signature": [ "{ registerTutorial: (specProvider: ", { @@ -1276,18 +1443,20 @@ ") => void; addScopedTutorialContextFactory: (scopedTutorialContextFactory: ", "ScopedTutorialContextFactory", ") => void; }" - ] + ], + "source": { + "path": "src/plugins/home/server/plugin.ts", + "lineNumber": 55 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.HomeServerPluginSetup.sampleData", "type": "Object", + "tags": [], "label": "sampleData", "description": [], - "source": { - "path": "src/plugins/home/server/plugin.ts", - "lineNumber": 56 - }, "signature": [ "{ registerSampleDataset: (specProvider: ", { @@ -1305,58 +1474,63 @@ "AppLinkSchema", "[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ", "SampleDatasetDashboardPanel" - ] + ], + "source": { + "path": "src/plugins/home/server/plugin.ts", + "lineNumber": 56 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/home/server/plugin.ts", - "lineNumber": 54 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "home", "id": "def-server.HomeServerPluginStart", "type": "Interface", + "tags": [], "label": "HomeServerPluginStart", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/plugins/home/server/plugin.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "home", "id": "def-server.HomeServerPluginStart.tutorials", "type": "Object", + "tags": [], "label": "tutorials", "description": [], + "signature": [ + "{}" + ], "source": { "path": "src/plugins/home/server/plugin.ts", "lineNumber": 61 }, - "signature": [ - "{}" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "home", "id": "def-server.HomeServerPluginStart.sampleData", "type": "Object", + "tags": [], "label": "sampleData", "description": [], + "signature": [ + "{}" + ], "source": { "path": "src/plugins/home/server/plugin.ts", "lineNumber": 62 }, - "signature": [ - "{}" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/home/server/plugin.ts", - "lineNumber": 60 - }, "lifecycle": "start", "initialIsOpen": true } diff --git a/api_docs/index_lifecycle_management.json b/api_docs/index_lifecycle_management.json index d5b36eeb587d6..b38b0a13b9044 100644 --- a/api_docs/index_lifecycle_management.json +++ b/api_docs/index_lifecycle_management.json @@ -5,77 +5,87 @@ "functions": [], "interfaces": [ { + "parentPluginId": "indexLifecycleManagement", "id": "def-public.IlmUrlGeneratorState", "type": "Interface", + "tags": [], "label": "IlmUrlGeneratorState", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexLifecycleManagement", "id": "def-public.IlmUrlGeneratorState.page", "type": "CompoundType", + "tags": [], "label": "page", "description": [], + "signature": [ + "\"policies_list\" | \"policy_edit\" | \"policy_create\"" + ], "source": { "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", "lineNumber": 22 }, - "signature": [ - "\"policies_list\" | \"policy_edit\" | \"policy_create\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexLifecycleManagement", "id": "def-public.IlmUrlGeneratorState.policyName", "type": "string", + "tags": [], "label": "policyName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", "lineNumber": 23 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexLifecycleManagement", "id": "def-public.IlmUrlGeneratorState.absolute", "type": "CompoundType", + "tags": [], "label": "absolute", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", "lineNumber": 24 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", - "lineNumber": 21 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "indexLifecycleManagement", "id": "def-public.ILM_URL_GENERATOR_ID", "type": "string", + "tags": [], "label": "ILM_URL_GENERATOR_ID", "description": [], + "signature": [ + "\"ILM_URL_GENERATOR_ID\"" + ], "source": { "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", "lineNumber": 19 }, - "signature": [ - "\"ILM_URL_GENERATOR_ID\"" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/index_management.json b/api_docs/index_management.json index cea9783521373..5e95a720f3d18 100644 --- a/api_docs/index_management.json +++ b/api_docs/index_management.json @@ -4,240 +4,278 @@ "classes": [], "functions": [ { + "parentPluginId": "indexManagement", "id": "def-public.getIndexListUri", "type": "Function", + "tags": [], + "label": "getIndexListUri", + "description": [], + "signature": [ + "(filter?: string | undefined, includeHiddenIndices?: boolean | undefined) => string" + ], + "source": { + "path": "x-pack/plugins/index_management/public/application/services/routing.ts", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexManagement", "id": "def-public.getIndexListUri.$1", "type": "string", + "tags": [], "label": "filter", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/index_management/public/application/services/routing.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "indexManagement", "id": "def-public.getIndexListUri.$2", "type": "CompoundType", + "tags": [], "label": "includeHiddenIndices", - "isRequired": false, + "description": [], "signature": [ "boolean | undefined" ], - "description": [], "source": { "path": "x-pack/plugins/index_management/public/application/services/routing.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(filter?: string | undefined, includeHiddenIndices?: boolean | undefined) => string" - ], - "description": [], - "label": "getIndexListUri", - "source": { - "path": "x-pack/plugins/index_management/public/application/services/routing.ts", - "lineNumber": 38 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "indexManagement", "id": "def-public.Index", "type": "Interface", + "tags": [], "label": "Index", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.health", "type": "string", + "tags": [], "label": "health", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.status", "type": "string", + "tags": [], "label": "status", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 56 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.uuid", "type": "string", + "tags": [], "label": "uuid", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 58 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.primary", "type": "string", + "tags": [], "label": "primary", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 59 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.replica", "type": "string", + "tags": [], "label": "replica", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 60 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.documents", "type": "Any", + "tags": [], "label": "documents", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 61 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.size", "type": "Any", + "tags": [], "label": "size", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 62 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.isFrozen", "type": "boolean", + "tags": [], "label": "isFrozen", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 63 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.aliases", "type": "CompoundType", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 64 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.Index.data_stream", "type": "string", + "tags": [], "label": "data_stream", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 65 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "indexManagement", "id": "def-public.Index.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 66 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/indices.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-public.IndexManagementPluginSetup", "type": "Interface", + "tags": [], "label": "IndexManagementPluginSetup", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/public/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-public.IndexManagementPluginSetup.extensionsService", "type": "Object", + "tags": [], "label": "extensionsService", "description": [], + "signature": [ + "ExtensionsSetup" + ], "source": { "path": "x-pack/plugins/index_management/public/types.ts", "lineNumber": 14 }, - "signature": [ - "ExtensionsSetup" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/public/types.ts", - "lineNumber": 13 - }, "initialIsOpen": false } ], @@ -250,22 +288,25 @@ "functions": [], "interfaces": [ { + "parentPluginId": "indexManagement", "id": "def-server.Dependencies", "type": "Interface", + "tags": [], "label": "Dependencies", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Dependencies.security", "type": "Object", + "tags": [], "label": "security", "description": [], - "source": { - "path": "x-pack/plugins/index_management/server/types.ts", - "lineNumber": 21 - }, "signature": [ { "pluginId": "security", @@ -274,18 +315,20 @@ "section": "def-server.SecurityPluginSetup", "text": "SecurityPluginSetup" } - ] + ], + "source": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Dependencies.licensing", "type": "Object", + "tags": [], "label": "licensing", "description": [], - "source": { - "path": "x-pack/plugins/index_management/server/types.ts", - "lineNumber": 22 - }, "signature": [ { "pluginId": "licensing", @@ -294,18 +337,20 @@ "section": "def-server.LicensingPluginSetup", "text": "LicensingPluginSetup" } - ] + ], + "source": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 22 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Dependencies.features", "type": "Object", + "tags": [], "label": "features", "description": [], - "source": { - "path": "x-pack/plugins/index_management/server/types.ts", - "lineNumber": 23 - }, "signature": [ { "pluginId": "features", @@ -314,223 +359,257 @@ "section": "def-server.PluginSetupContract", "text": "PluginSetupContract" } - ] + ], + "source": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 23 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/server/types.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-server.Index", "type": "Interface", + "tags": [], "label": "Index", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.health", "type": "string", + "tags": [], "label": "health", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.status", "type": "string", + "tags": [], "label": "status", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 56 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.uuid", "type": "string", + "tags": [], "label": "uuid", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 58 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.primary", "type": "string", + "tags": [], "label": "primary", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 59 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.replica", "type": "string", + "tags": [], "label": "replica", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 60 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.documents", "type": "Any", + "tags": [], "label": "documents", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 61 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.size", "type": "Any", + "tags": [], "label": "size", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 62 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.isFrozen", "type": "boolean", + "tags": [], "label": "isFrozen", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 63 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.aliases", "type": "CompoundType", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 64 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.Index.data_stream", "type": "string", + "tags": [], "label": "data_stream", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 65 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "indexManagement", "id": "def-server.Index.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 66 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/indices.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-server.LegacyTemplateSerialized", "type": "Interface", + "tags": [], "label": "LegacyTemplateSerialized", "description": [ "\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------" ], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 99 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.LegacyTemplateSerialized.index_patterns", "type": "Array", + "tags": [], "label": "index_patterns", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 100 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.LegacyTemplateSerialized.version", "type": "number", + "tags": [], "label": "version", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 101 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.LegacyTemplateSerialized.settings", "type": "Object", + "tags": [], "label": "settings", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 102 - }, "signature": [ { "pluginId": "indexManagement", @@ -540,18 +619,20 @@ "text": "IndexSettings" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 102 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.LegacyTemplateSerialized.aliases", "type": "Object", + "tags": [], "label": "aliases", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 103 - }, "signature": [ { "pluginId": "indexManagement", @@ -561,18 +642,20 @@ "text": "Aliases" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 103 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.LegacyTemplateSerialized.mappings", "type": "Object", + "tags": [], "label": "mappings", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 104 - }, "signature": [ { "pluginId": "indexManagement", @@ -582,77 +665,86 @@ "text": "Mappings" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 104 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.LegacyTemplateSerialized.order", "type": "number", + "tags": [], "label": "order", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 105 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 99 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "indexManagement", "id": "def-server.IndexManagementConfig", "type": "Type", - "label": "IndexManagementConfig", "tags": [], + "label": "IndexManagementConfig", "description": [], + "signature": [ + "{ readonly enabled: boolean; }" + ], "source": { "path": "x-pack/plugins/index_management/server/config.ts", "lineNumber": 14 }, - "signature": [ - "{ readonly enabled: boolean; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "indexManagement", "id": "def-server.IndexManagementPluginSetup", "type": "Interface", + "tags": [], "label": "IndexManagementPluginSetup", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/server/plugin.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-server.IndexManagementPluginSetup.indexDataEnricher", "type": "Object", + "tags": [], "label": "indexDataEnricher", "description": [], - "source": { - "path": "x-pack/plugins/index_management/server/plugin.ts", - "lineNumber": 26 - }, "signature": [ "{ add: (enricher: ", "Enricher", ") => void; }" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/server/plugin.ts", + "lineNumber": 26 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/server/plugin.ts", - "lineNumber": 25 - }, "lifecycle": "setup", "initialIsOpen": true } @@ -661,14 +753,52 @@ "classes": [], "functions": [ { + "parentPluginId": "indexManagement", "id": "def-common.getTemplateParameter", "type": "Function", + "tags": [], + "label": "getTemplateParameter", + "description": [], + "signature": [ + "(template: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.LegacyTemplateSerialized", + "text": "LegacyTemplateSerialized" + }, + " | ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.TemplateSerialized", + "text": "TemplateSerialized" + }, + ", setting: \"aliases\" | \"settings\" | \"mappings\") => ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Aliases", + "text": "Aliases" + }, + " | undefined" + ], + "source": { + "path": "x-pack/plugins/index_management/common/lib/utils.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexManagement", "id": "def-common.getTemplateParameter.$1", "type": "CompoundType", + "tags": [], "label": "template", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "indexManagement", @@ -686,98 +816,75 @@ "text": "TemplateSerialized" } ], - "description": [], "source": { "path": "x-pack/plugins/index_management/common/lib/utils.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "indexManagement", "id": "def-common.getTemplateParameter.$2", "type": "CompoundType", + "tags": [], "label": "setting", - "isRequired": true, + "description": [], "signature": [ "\"aliases\" | \"settings\" | \"mappings\"" ], - "description": [], "source": { "path": "x-pack/plugins/index_management/common/lib/utils.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(template: ", - { - "pluginId": "indexManagement", - "scope": "common", - "docId": "kibIndexManagementPluginApi", - "section": "def-common.LegacyTemplateSerialized", - "text": "LegacyTemplateSerialized" - }, - " | ", - { - "pluginId": "indexManagement", - "scope": "common", - "docId": "kibIndexManagementPluginApi", - "section": "def-common.TemplateSerialized", - "text": "TemplateSerialized" - }, - ", setting: \"aliases\" | \"settings\" | \"mappings\") => ", - { - "pluginId": "indexManagement", - "scope": "common", - "docId": "kibIndexManagementPluginApi", - "section": "def-common.Aliases", - "text": "Aliases" - }, - " | undefined" - ], - "description": [], - "label": "getTemplateParameter", - "source": { - "path": "x-pack/plugins/index_management/common/lib/utils.ts", - "lineNumber": 21 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "indexManagement", "id": "def-common.Aliases", "type": "Interface", + "tags": [], "label": "Aliases", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/aliases.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexManagement", "id": "def-common.Aliases.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/aliases.ts", "lineNumber": 9 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/aliases.ts", - "lineNumber": 8 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateDeserialized", "type": "Interface", + "tags": [], "label": "ComponentTemplateDeserialized", + "description": [], "signature": [ { "pluginId": "indexManagement", @@ -795,69 +902,77 @@ "text": "ComponentTemplateSerialized" } ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateDeserialized.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 23 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateDeserialized._kbnMeta", "type": "Object", + "tags": [], "label": "_kbnMeta", "description": [], + "signature": [ + "{ usedBy: string[]; isManaged: boolean; }" + ], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 24 }, - "signature": [ - "{ usedBy: string[]; isManaged: boolean; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/component_templates.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateFromEs", "type": "Interface", + "tags": [], "label": "ComponentTemplateFromEs", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateFromEs.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateFromEs.component_template", "type": "Object", + "tags": [], "label": "component_template", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/component_templates.ts", - "lineNumber": 32 - }, "signature": [ { "pluginId": "indexManagement", @@ -866,115 +981,133 @@ "section": "def-common.ComponentTemplateSerialized", "text": "ComponentTemplateSerialized" } - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 32 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/component_templates.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateListItem", "type": "Interface", + "tags": [], "label": "ComponentTemplateListItem", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateListItem.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 36 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateListItem.usedBy", "type": "Array", + "tags": [], "label": "usedBy", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 37 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateListItem.hasMappings", "type": "boolean", + "tags": [], "label": "hasMappings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 38 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateListItem.hasAliases", "type": "boolean", + "tags": [], "label": "hasAliases", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 39 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateListItem.hasSettings", "type": "boolean", + "tags": [], "label": "hasSettings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 40 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateListItem.isManaged", "type": "boolean", + "tags": [], "label": "isManaged", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 41 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/component_templates.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateSerialized", "type": "Interface", + "tags": [], "label": "ComponentTemplateSerialized", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateSerialized.template", "type": "Object", + "tags": [], "label": "template", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/component_templates.ts", - "lineNumber": 13 - }, "signature": [ "{ settings?: ", { @@ -1001,85 +1134,97 @@ "text": "Mappings" }, " | undefined; }" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 13 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateSerialized.version", "type": "number", + "tags": [], "label": "version", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 18 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.ComponentTemplateSerialized._meta", "type": "Object", + "tags": [], "label": "_meta", "description": [], + "signature": [ + "{ [key: string]: any; } | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 19 }, - "signature": [ - "{ [key: string]: any; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/component_templates.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.DataStream", "type": "Interface", + "tags": [], "label": "DataStream", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 54 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.timeStampField", "type": "Object", + "tags": [], "label": "timeStampField", "description": [], + "signature": [ + "TimestampFieldFromEs" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 55 }, - "signature": [ - "TimestampFieldFromEs" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.indices", "type": "Array", + "tags": [], "label": "indices", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/data_streams.ts", - "lineNumber": 56 - }, "signature": [ { "pluginId": "indexManagement", @@ -1089,631 +1234,727 @@ "text": "DataStreamIndex" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.generation", "type": "number", + "tags": [], "label": "generation", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.health", "type": "CompoundType", + "tags": [], "label": "health", "description": [], + "signature": [ + "ClusterStatus" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 58 }, - "signature": [ - "ClusterStatus" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.indexTemplateName", "type": "string", + "tags": [], "label": "indexTemplateName", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 59 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.ilmPolicyName", "type": "string", + "tags": [], "label": "ilmPolicyName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 60 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.storageSize", "type": "string", + "tags": [], "label": "storageSize", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 61 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.storageSizeBytes", "type": "number", + "tags": [], "label": "storageSizeBytes", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 62 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.maxTimeStamp", "type": "number", + "tags": [], "label": "maxTimeStamp", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 63 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream._meta", "type": "Object", + "tags": [], "label": "_meta", "description": [], + "signature": [ + "MetaFromEs | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 64 }, - "signature": [ - "MetaFromEs | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.privileges", "type": "Object", + "tags": [], "label": "privileges", "description": [], + "signature": [ + "PrivilegesFromEs" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 65 }, - "signature": [ - "PrivilegesFromEs" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStream.hidden", "type": "boolean", + "tags": [], "label": "hidden", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 66 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/data_streams.ts", - "lineNumber": 53 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs", "type": "Interface", + "tags": [], "label": "DataStreamFromEs", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 30 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.timestamp_field", "type": "Object", + "tags": [], "label": "timestamp_field", "description": [], + "signature": [ + "TimestampFieldFromEs" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 32 }, - "signature": [ - "TimestampFieldFromEs" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.indices", "type": "Array", + "tags": [], "label": "indices", "description": [], + "signature": [ + "DataStreamIndexFromEs", + "[]" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 33 }, - "signature": [ - "DataStreamIndexFromEs", - "[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.generation", "type": "number", + "tags": [], "label": "generation", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 34 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs._meta", "type": "Object", + "tags": [], "label": "_meta", "description": [], + "signature": [ + "MetaFromEs | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 35 }, - "signature": [ - "MetaFromEs | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.status", "type": "CompoundType", + "tags": [], "label": "status", "description": [], + "signature": [ + "HealthFromEs" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 36 }, - "signature": [ - "HealthFromEs" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.template", "type": "string", + "tags": [], "label": "template", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 37 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.ilm_policy", "type": "string", + "tags": [], "label": "ilm_policy", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 38 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.store_size", "type": "string", + "tags": [], "label": "store_size", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 39 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.store_size_bytes", "type": "number", + "tags": [], "label": "store_size_bytes", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 40 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.maximum_timestamp", "type": "number", + "tags": [], "label": "maximum_timestamp", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 41 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.privileges", "type": "Object", + "tags": [], "label": "privileges", "description": [], + "signature": [ + "PrivilegesFromEs" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 42 }, - "signature": [ - "PrivilegesFromEs" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamFromEs.hidden", "type": "boolean", + "tags": [], "label": "hidden", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 43 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/data_streams.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.DataStreamIndex", "type": "Interface", + "tags": [], "label": "DataStreamIndex", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 69 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamIndex.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 70 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.DataStreamIndex.uuid", "type": "string", + "tags": [], "label": "uuid", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 71 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/data_streams.ts", - "lineNumber": 69 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.Index", "type": "Interface", + "tags": [], "label": "Index", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.health", "type": "string", + "tags": [], "label": "health", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 55 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.status", "type": "string", + "tags": [], "label": "status", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 56 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 57 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.uuid", "type": "string", + "tags": [], "label": "uuid", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 58 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.primary", "type": "string", + "tags": [], "label": "primary", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 59 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.replica", "type": "string", + "tags": [], "label": "replica", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 60 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.documents", "type": "Any", + "tags": [], "label": "documents", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 61 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.size", "type": "Any", + "tags": [], "label": "size", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 62 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.isFrozen", "type": "boolean", + "tags": [], "label": "isFrozen", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 63 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.aliases", "type": "CompoundType", + "tags": [], "label": "aliases", "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 64 }, - "signature": [ - "string | string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.Index.data_stream", "type": "string", + "tags": [], "label": "data_stream", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 65 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { + "parentPluginId": "indexManagement", "id": "def-common.Index.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 66 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/indices.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.IndexSettings", "type": "Interface", + "tags": [], "label": "IndexSettings", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.IndexSettings.index", "type": "Object", + "tags": [], "label": "index", "description": [], + "signature": [ + "Partial | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 49 }, - "signature": [ - "Partial | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.IndexSettings.analysis", "type": "Object", + "tags": [], "label": "analysis", "description": [], + "signature": [ + "AnalysisModule | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 50 }, - "signature": [ - "AnalysisModule | undefined" - ] + "deprecated": false }, { + "parentPluginId": "indexManagement", "id": "def-common.IndexSettings.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 51 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/indices.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.LegacyTemplateSerialized", "type": "Interface", + "tags": [], "label": "LegacyTemplateSerialized", "description": [ "\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------" ], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 99 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.LegacyTemplateSerialized.index_patterns", "type": "Array", + "tags": [], "label": "index_patterns", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 100 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.LegacyTemplateSerialized.version", "type": "number", + "tags": [], "label": "version", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 101 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.LegacyTemplateSerialized.settings", "type": "Object", + "tags": [], "label": "settings", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 102 - }, "signature": [ { "pluginId": "indexManagement", @@ -1723,18 +1964,20 @@ "text": "IndexSettings" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 102 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.LegacyTemplateSerialized.aliases", "type": "Object", + "tags": [], "label": "aliases", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 103 - }, "signature": [ { "pluginId": "indexManagement", @@ -1744,18 +1987,20 @@ "text": "Aliases" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 103 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.LegacyTemplateSerialized.mappings", "type": "Object", + "tags": [], "label": "mappings", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 104 - }, "signature": [ { "pluginId": "indexManagement", @@ -1765,101 +2010,115 @@ "text": "Mappings" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 104 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.LegacyTemplateSerialized.order", "type": "number", + "tags": [], "label": "order", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 105 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 99 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.Mappings", "type": "Interface", + "tags": [], "label": "Mappings", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/mappings.ts", + "lineNumber": 10 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexManagement", "id": "def-common.Mappings.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/index_management/common/types/mappings.ts", "lineNumber": 11 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/mappings.ts", - "lineNumber": 10 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized", "type": "Interface", + "tags": [], "label": "TemplateDeserialized", "description": [ "\nTemplateDeserialized is the format the UI will be working with,\nregardless if we are loading the new format (composable) index template,\nor the legacy one. Serialization is done server side." ], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 35 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized.indexPatterns", "type": "Array", + "tags": [], "label": "indexPatterns", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 36 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized.template", "type": "Object", + "tags": [], "label": "template", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 37 - }, "signature": [ "{ settings?: ", { @@ -1886,116 +2145,132 @@ "text": "Mappings" }, " | undefined; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized.composedOf", "type": "Array", + "tags": [], "label": "composedOf", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 42 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized.version", "type": "number", + "tags": [], "label": "version", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 43 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized.priority", "type": "number", + "tags": [], "label": "priority", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 44 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized.order", "type": "number", + "tags": [], "label": "order", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 45 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized.ilmPolicy", "type": "Object", + "tags": [], "label": "ilmPolicy", "description": [], + "signature": [ + "{ name: string; } | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 46 }, - "signature": [ - "{ name: string; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized._meta", "type": "Object", + "tags": [], "label": "_meta", "description": [], + "signature": [ + "{ [key: string]: any; } | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 49 }, - "signature": [ - "{ [key: string]: any; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized.dataStream", "type": "Object", + "tags": [], "label": "dataStream", "description": [], + "signature": [ + "{ [key: string]: any; hidden?: boolean | undefined; } | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 51 }, - "signature": [ - "{ [key: string]: any; hidden?: boolean | undefined; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateDeserialized._kbnMeta", "type": "Object", + "tags": [], "label": "_kbnMeta", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 55 - }, "signature": [ "{ type: ", { @@ -2006,43 +2281,49 @@ "text": "TemplateType" }, "; hasDatastream: boolean; isLegacy?: boolean | undefined; }" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 55 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 34 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.TemplateFromEs", "type": "Interface", + "tags": [], "label": "TemplateFromEs", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateFromEs.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 65 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateFromEs.index_template", "type": "Object", + "tags": [], "label": "index_template", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 66 - }, "signature": [ { "pluginId": "indexManagement", @@ -2051,148 +2332,170 @@ "section": "def-common.TemplateSerialized", "text": "TemplateSerialized" } - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 66 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 64 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem", "type": "Interface", + "tags": [], "label": "TemplateListItem", "description": [ "\nInterface for the template list in our UI table\nwe don't include the mappings, settings and aliases\nto reduce the payload size sent back to the client." ], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 75 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem.indexPatterns", "type": "Array", + "tags": [], "label": "indexPatterns", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 76 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem.version", "type": "number", + "tags": [], "label": "version", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 77 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem.order", "type": "number", + "tags": [], "label": "order", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 78 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem.priority", "type": "number", + "tags": [], "label": "priority", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 79 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem.hasSettings", "type": "boolean", + "tags": [], "label": "hasSettings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 80 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem.hasAliases", "type": "boolean", + "tags": [], "label": "hasAliases", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 81 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem.hasMappings", "type": "boolean", + "tags": [], "label": "hasMappings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 82 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem.ilmPolicy", "type": "Object", + "tags": [], "label": "ilmPolicy", "description": [], + "signature": [ + "{ name: string; } | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 83 }, - "signature": [ - "{ name: string; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateListItem._kbnMeta", "type": "Object", + "tags": [], "label": "_kbnMeta", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 86 - }, "signature": [ "{ type: ", { @@ -2203,48 +2506,54 @@ "text": "TemplateType" }, "; hasDatastream: boolean; isLegacy?: boolean | undefined; }" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 86 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 74 - }, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.TemplateSerialized", "type": "Interface", + "tags": [], "label": "TemplateSerialized", "description": [ "\nIndex template format from Elasticsearch" ], - "tags": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateSerialized.index_patterns", "type": "Array", + "tags": [], "label": "index_patterns", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 16 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateSerialized.template", "type": "Object", + "tags": [], "label": "template", "description": [], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 17 - }, "signature": [ "{ settings?: ", { @@ -2271,146 +2580,165 @@ "text": "Mappings" }, " | undefined; } | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 17 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateSerialized.composed_of", "type": "Array", + "tags": [], "label": "composed_of", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 22 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateSerialized.version", "type": "number", + "tags": [], "label": "version", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 23 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateSerialized.priority", "type": "number", + "tags": [], "label": "priority", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 24 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateSerialized._meta", "type": "Object", + "tags": [], "label": "_meta", "description": [], + "signature": [ + "{ [key: string]: any; } | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 25 }, - "signature": [ - "{ [key: string]: any; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.TemplateSerialized.data_stream", "type": "Object", + "tags": [], "label": "data_stream", "description": [], + "signature": [ + "{} | undefined" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 26 }, - "signature": [ - "{} | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/index_management/common/types/templates.ts", - "lineNumber": 15 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.API_BASE_PATH", "type": "string", + "tags": [], "label": "API_BASE_PATH", "description": [], + "signature": [ + "\"/api/index_management\"" + ], "source": { "path": "x-pack/plugins/index_management/common/constants/api_base_path.ts", "lineNumber": 8 }, - "signature": [ - "\"/api/index_management\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "indexManagement", "id": "def-common.BASE_PATH", "type": "string", + "tags": [], "label": "BASE_PATH", "description": [], + "signature": [ + "\"/management/data/index_management/\"" + ], "source": { "path": "x-pack/plugins/index_management/common/constants/base_path.ts", "lineNumber": 8 }, - "signature": [ - "\"/management/data/index_management/\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.Health", "type": "Type", - "label": "Health", "tags": [], + "label": "Health", "description": [], + "signature": [ + "\"green\" | \"yellow\" | \"red\"" + ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 51 }, - "signature": [ - "\"green\" | \"yellow\" | \"red\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "indexManagement", "id": "def-common.TemplateType", "type": "Type", - "label": "TemplateType", "tags": [], + "label": "TemplateType", "description": [], + "signature": [ + "\"default\" | \"system\" | \"managed\" | \"cloudManaged\"" + ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 62 }, - "signature": [ - "\"default\" | \"system\" | \"managed\" | \"cloudManaged\"" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/index_pattern_field_editor.json b/api_docs/index_pattern_field_editor.json index 00d77023c0410..15f00324d585f 100644 --- a/api_docs/index_pattern_field_editor.json +++ b/api_docs/index_pattern_field_editor.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.DefaultFormatEditor", "type": "Class", "tags": [], @@ -22,37 +23,49 @@ "FormatEditorState", " & S, any>" ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 71 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.DefaultFormatEditor.formatId", "type": "string", + "tags": [], "label": "formatId", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 75 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.DefaultFormatEditor.state", "type": "CompoundType", + "tags": [], "label": "state", "description": [], + "signature": [ + "FormatEditorState", + " & S" + ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 76 }, - "signature": [ - "FormatEditorState", - " & S" - ] + "deprecated": false }, { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.DefaultFormatEditor.getDerivedStateFromProps", "type": "Function", + "tags": [], "label": "getDerivedStateFromProps", + "description": [], "signature": [ "typeof ", { @@ -64,119 +77,130 @@ }, ".getDerivedStateFromProps" ], - "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 78 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.DefaultFormatEditor.getDerivedStateFromProps.$1", "type": "Object", + "tags": [], "label": "nextProps", - "isRequired": true, + "description": [], "signature": [ "FormatEditorProps", "<{}>" ], - "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 78 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.DefaultFormatEditor.getDerivedStateFromProps.$2", "type": "Object", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ "FormatEditorState" ], - "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 78 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", - "lineNumber": 78 - } + "returnComment": [] }, { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.DefaultFormatEditor.onChange", "type": "Function", + "tags": [], + "label": "onChange", + "description": [], + "signature": [ + "(newParams?: {}) => void" + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 90 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.DefaultFormatEditor.onChange.$1", "type": "Object", + "tags": [], "label": "newParams", - "isRequired": true, + "description": [], "signature": [ "{}" ], - "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 90 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(newParams?: {}) => void" - ], - "description": [], - "label": "onChange", - "source": { - "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", - "lineNumber": 90 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.DefaultFormatEditor.render", "type": "Function", + "tags": [], "label": "render", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 99 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", - "lineNumber": 71 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.FieldEditorContext", "type": "Interface", + "tags": [], "label": "FieldEditorContext", "description": [], - "tags": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.FieldEditorContext.indexPattern", "type": "Object", + "tags": [], "label": "indexPattern", "description": [], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", - "lineNumber": 28 - }, "signature": [ { "pluginId": "data", @@ -185,36 +209,40 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" } - ] + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", + "lineNumber": 28 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.FieldEditorContext.fieldTypeToProcess", "type": "CompoundType", + "tags": [], "label": "fieldTypeToProcess", "description": [ "\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\"" ], + "signature": [ + "InternalFieldType" + ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", "lineNumber": 33 }, - "signature": [ - "InternalFieldType" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.FieldEditorContext.search", "type": "Object", + "tags": [], "label": "search", "description": [ "The search service from the data plugin" ], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", - "lineNumber": 35 - }, "signature": [ { "pluginId": "data", @@ -223,32 +251,36 @@ "section": "def-public.ISearchStart", "text": "ISearchStart" } - ] + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", + "lineNumber": 35 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.OpenFieldDeleteModalOptions", "type": "Interface", + "tags": [], "label": "OpenFieldDeleteModalOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.OpenFieldDeleteModalOptions.ctx", "type": "Object", + "tags": [], "label": "ctx", "description": [], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", - "lineNumber": 25 - }, "signature": [ "{ indexPattern: ", { @@ -259,60 +291,68 @@ "text": "IndexPattern" }, "; }" - ] + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", + "lineNumber": 25 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.OpenFieldDeleteModalOptions.onDelete", "type": "Function", + "tags": [], "label": "onDelete", "description": [], + "signature": [ + "((fieldNames: string[]) => void) | undefined" + ], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", "lineNumber": 28 }, - "signature": [ - "((fieldNames: string[]) => void) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.OpenFieldDeleteModalOptions.fieldName", "type": "CompoundType", + "tags": [], "label": "fieldName", "description": [], + "signature": [ + "string | string[]" + ], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", "lineNumber": 29 }, - "signature": [ - "string | string[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.OpenFieldEditorOptions", "type": "Interface", + "tags": [], "label": "OpenFieldEditorOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.OpenFieldEditorOptions.ctx", "type": "Object", + "tags": [], "label": "ctx", "description": [], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", - "lineNumber": 28 - }, "signature": [ "{ indexPattern: ", { @@ -323,18 +363,20 @@ "text": "IndexPattern" }, "; }" - ] + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 28 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.OpenFieldEditorOptions.onSave", "type": "Function", + "tags": [], "label": "onSave", "description": [], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", - "lineNumber": 31 - }, "signature": [ "((field: ", { @@ -345,27 +387,30 @@ "text": "IndexPatternField" }, ") => void) | undefined" - ] + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 31 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.OpenFieldEditorOptions.fieldName", "type": "string", + "tags": [], "label": "fieldName", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", "lineNumber": 32 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", - "lineNumber": 27 - }, "initialIsOpen": false } ], @@ -373,16 +418,25 @@ "misc": [], "objects": [], "start": { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.PluginStart", "type": "Interface", + "tags": [], "label": "PluginStart", "description": [], - "tags": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.PluginStart.openEditor", "type": "Function", + "tags": [], "label": "openEditor", + "description": [], "signature": [ "(options: ", { @@ -394,13 +448,19 @@ }, ") => () => void" ], - "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.PluginStart.openEditor.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "indexPatternFieldEditor", @@ -410,24 +470,23 @@ "text": "OpenFieldEditorOptions" } ], - "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/types.ts", - "lineNumber": 27 - } + "returnComment": [] }, { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.PluginStart.openDeleteModal", "type": "Function", + "tags": [], "label": "openDeleteModal", + "description": [], "signature": [ "(options: ", { @@ -439,13 +498,19 @@ }, ") => () => void" ], - "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.PluginStart.openDeleteModal.$1", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "indexPatternFieldEditor", @@ -455,30 +520,23 @@ "text": "OpenFieldDeleteModalOptions" } ], - "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/types.ts", - "lineNumber": 28 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.PluginStart.fieldFormatEditors", "type": "Object", + "tags": [], "label": "fieldFormatEditors", "description": [], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/types.ts", - "lineNumber": 29 - }, "signature": [ "{ getAll: () => typeof ", { @@ -497,43 +555,48 @@ "text": "DefaultFormatEditor" }, " | undefined; }" - ] + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.PluginStart.userPermissions", "type": "Object", + "tags": [], "label": "userPermissions", "description": [], + "signature": [ + "{ editIndexPattern: () => boolean; }" + ], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 30 }, - "signature": [ - "{ editIndexPattern: () => boolean; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternFieldEditor", "id": "def-public.PluginStart.DeleteRuntimeFieldProvider", "type": "Function", + "tags": [], "label": "DeleteRuntimeFieldProvider", "description": [], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/types.ts", - "lineNumber": 33 - }, "signature": [ "React.FunctionComponent<", "Props", ">" - ] + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 33 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/index_pattern_field_editor/public/types.ts", - "lineNumber": 26 - }, "lifecycle": "start", "initialIsOpen": true } diff --git a/api_docs/index_pattern_management.json b/api_docs/index_pattern_management.json index 4ce56a42df205..9676ef7b4b9c3 100644 --- a/api_docs/index_pattern_management.json +++ b/api_docs/index_pattern_management.json @@ -3,191 +3,226 @@ "client": { "classes": [ { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig", "type": "Class", "tags": [], "label": "IndexPatternCreationConfig", "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.key", "type": "string", + "tags": [], "label": "key", "description": [], + "signature": [ + "\"default\"" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 38 }, - "signature": [ - "\"default\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 40 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 41 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.showSystemIndices", "type": "boolean", + "tags": [], "label": "showSystemIndices", "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 42 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.httpClient", "type": "CompoundType", + "tags": [], "label": "httpClient", "description": [], + "signature": [ + "object | null" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 43 }, - "signature": [ - "object | null" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.isBeta", "type": "boolean", + "tags": [], "label": "isBeta", "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 44 - } + }, + "deprecated": false }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse", "type": "Object", - "label": "{\n type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }", "tags": [], + "label": "{\n type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }", "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 52 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 53 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse.name", "type": "string", + "tags": [], "label": "name", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 54 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse.showSystemIndices", "type": "CompoundType", + "tags": [], "label": "showSystemIndices", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 55 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse.httpClient", "type": "CompoundType", + "tags": [], "label": "httpClient", "description": [], + "signature": [ + "object | null | undefined" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 56 }, - "signature": [ - "object | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse.isBeta", "type": "CompoundType", + "tags": [], "label": "isBeta", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 57 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", - "lineNumber": 52 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", - "lineNumber": 46 - } + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.getIndexPatternCreationOption", "type": "Function", + "tags": [], "label": "getIndexPatternCreationOption", + "description": [], "signature": [ "(urlHandler: ", "UrlHandler", @@ -200,239 +235,272 @@ "text": "IndexPatternCreationOption" } ], - "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 66 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.getIndexPatternCreationOption.$1", "type": "Function", + "tags": [], "label": "urlHandler", - "isRequired": true, + "description": [], "signature": [ "UrlHandler" ], - "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 66 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", - "lineNumber": 66 - } + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.getIndexPatternType", "type": "Function", + "tags": [], "label": "getIndexPatternType", + "description": [], "signature": [ "() => string | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 77 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.getIndexPatternName", "type": "Function", + "tags": [], "label": "getIndexPatternName", + "description": [], "signature": [ "() => string" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.getIsBeta", "type": "Function", + "tags": [], "label": "getIsBeta", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 85 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.getShowSystemIndices", "type": "Function", + "tags": [], "label": "getShowSystemIndices", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 89 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.getIndexTags", "type": "Function", + "tags": [], "label": "getIndexTags", + "description": [], "signature": [ "(indexName: string) => never[]" ], - "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 93 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.getIndexTags.$1", "type": "string", + "tags": [], "label": "indexName", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 93 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", - "lineNumber": 93 - } + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.checkIndicesForErrors", "type": "Function", + "tags": [], "label": "checkIndicesForErrors", + "description": [], "signature": [ "(indices: ", "MatchedItem", "[]) => undefined" ], - "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 97 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.checkIndicesForErrors.$1", "type": "Array", + "tags": [], "label": "indices", - "isRequired": true, + "description": [], "signature": [ "MatchedItem", "[]" ], - "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 97 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", - "lineNumber": 97 - } + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.getIndexPatternMappings", "type": "Function", + "tags": [], "label": "getIndexPatternMappings", + "description": [], "signature": [ "() => {}" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 101 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.renderPrompt", "type": "Function", + "tags": [], "label": "renderPrompt", + "description": [], "signature": [ "() => null" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 105 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationConfig.getFetchForWildcardOptions", "type": "Function", + "tags": [], "label": "getFetchForWildcardOptions", + "description": [], "signature": [ "() => {}" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 109 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", - "lineNumber": 37 - }, "initialIsOpen": false }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternListConfig", "type": "Class", "tags": [], "label": "IndexPatternListConfig", "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternListConfig.key", "type": "string", + "tags": [], "label": "key", "description": [], + "signature": [ + "\"default\"" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/list/config.ts", "lineNumber": 26 }, - "signature": [ - "\"default\"" - ] + "deprecated": false }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternListConfig.getIndexPatternTags", "type": "Function", + "tags": [], "label": "getIndexPatternTags", + "description": [], "signature": [ "(indexPattern: ", { @@ -462,13 +530,19 @@ "IndexPatternTag", "[]" ], - "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternListConfig.getIndexPatternTags.$1", "type": "CompoundType", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -495,38 +569,40 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/list/config.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternListConfig.getIndexPatternTags.$2", "type": "boolean", + "tags": [], "label": "isDefault", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/list/config.ts", "lineNumber": 30 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/index_pattern_management/public/service/list/config.ts", - "lineNumber": 28 - } + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternListConfig.getFieldInfo", "type": "Function", + "tags": [], "label": "getFieldInfo", + "description": [], "signature": [ "(indexPattern: ", { @@ -546,13 +622,19 @@ }, ") => string[]" ], - "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternListConfig.getFieldInfo.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -562,17 +644,20 @@ "text": "IIndexPattern" } ], - "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/list/config.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternListConfig.getFieldInfo.$2", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -582,24 +667,23 @@ "text": "IFieldType" } ], - "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/list/config.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/index_pattern_management/public/service/list/config.ts", - "lineNumber": 42 - } + "returnComment": [] }, { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternListConfig.areScriptedFieldsEnabled", "type": "Function", + "tags": [], "label": "areScriptedFieldsEnabled", + "description": [], "signature": [ "(indexPattern: ", { @@ -611,13 +695,19 @@ }, ") => boolean" ], - "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternListConfig.areScriptedFieldsEnabled.$1", "type": "Object", + "tags": [], "label": "indexPattern", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -627,132 +717,135 @@ "text": "IIndexPattern" } ], - "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/list/config.ts", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/index_pattern_management/public/service/list/config.ts", - "lineNumber": 46 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/index_pattern_management/public/service/list/config.ts", - "lineNumber": 25 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationOption", "type": "Interface", + "tags": [], "label": "IndexPatternCreationOption", "description": [], - "tags": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationOption.text", "type": "string", + "tags": [], "label": "text", "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 30 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationOption.description", "type": "string", + "tags": [], "label": "description", "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 31 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationOption.testSubj", "type": "string", + "tags": [], "label": "testSubj", "description": [], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 32 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationOption.onClick", "type": "Function", + "tags": [], "label": "onClick", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 33 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternCreationOption.isBeta", "type": "CompoundType", + "tags": [], "label": "isBeta", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 34 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", - "lineNumber": 29 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "indexPatternManagement", "id": "def-public.MlCardState", "type": "Enum", - "label": "MlCardState", "tags": [], + "label": "MlCardState", "description": [], "source": { "path": "src/plugins/index_pattern_management/public/types.ts", "lineNumber": 42 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [], "objects": [], "setup": { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternManagementSetup", "type": "Type", - "label": "IndexPatternManagementSetup", "tags": [], + "label": "IndexPatternManagementSetup", "description": [], - "source": { - "path": "src/plugins/index_pattern_management/public/plugin.ts", - "lineNumber": 32 - }, "signature": [ "{ creation: { addCreationConfig: (Config: typeof ", { @@ -774,19 +867,21 @@ "Environment", ">) => void; }; }" ], + "source": { + "path": "src/plugins/index_pattern_management/public/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "indexPatternManagement", "id": "def-public.IndexPatternManagementStart", "type": "Type", - "label": "IndexPatternManagementStart", "tags": [], + "label": "IndexPatternManagementStart", "description": [], - "source": { - "path": "src/plugins/index_pattern_management/public/plugin.ts", - "lineNumber": 34 - }, "signature": [ "{ creation: { getType: (key: string | undefined) => ", { @@ -823,6 +918,11 @@ "text": "SimpleSavedObject" } ], + "source": { + "path": "src/plugins/index_pattern_management/public/plugin.ts", + "lineNumber": 34 + }, + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } diff --git a/api_docs/infra.json b/api_docs/infra.json index a9511cd9a7c80..8ff9ded3938e6 100644 --- a/api_docs/infra.json +++ b/api_docs/infra.json @@ -4,38 +4,43 @@ "classes": [], "functions": [ { + "parentPluginId": "infra", "id": "def-public.LazyLogStreamWrapper", "type": "Function", + "tags": [], + "label": "LazyLogStreamWrapper", + "description": [], + "signature": [ + "(props: React.PropsWithChildren<", + "LogStreamProps", + ">) => JSX.Element" + ], + "source": { + "path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { + "parentPluginId": "infra", "id": "def-public.LazyLogStreamWrapper.$1", "type": "CompoundType", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren<", "LogStreamProps", ">" ], - "description": [], "source": { "path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx", "lineNumber": 13 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(props: React.PropsWithChildren<", - "LogStreamProps", - ">) => JSX.Element" - ], - "description": [], - "label": "LazyLogStreamWrapper", - "source": { - "path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx", - "lineNumber": 13 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } @@ -43,138 +48,156 @@ "interfaces": [], "enums": [ { + "parentPluginId": "infra", "id": "def-public.InfraFormatterType", "type": "Enum", - "label": "InfraFormatterType", "tags": [], + "label": "InfraFormatterType", "description": [], "source": { "path": "x-pack/plugins/infra/public/lib/lib.ts", "lineNumber": 147 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "infra", "id": "def-public.InfraAppId", "type": "Type", - "label": "InfraAppId", "tags": [], + "label": "InfraAppId", "description": [], + "signature": [ + "\"metrics\" | \"logs\"" + ], "source": { "path": "x-pack/plugins/infra/public/index.ts", "lineNumber": 29 }, - "signature": [ - "\"metrics\" | \"logs\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { + "parentPluginId": "infra", "id": "def-public.FORMATTERS", "type": "Object", "tags": [], + "label": "FORMATTERS", + "description": [], + "source": { + "path": "x-pack/plugins/infra/common/formatters/index.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "infra", "id": "def-public.FORMATTERS.number", "type": "Function", + "tags": [], "label": "number", "description": [], + "signature": [ + "(val: number) => string" + ], "source": { "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 16 }, - "signature": [ - "(val: number) => string" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "infra", "id": "def-public.FORMATTERS.abbreviatedNumber", "type": "Function", + "tags": [], "label": "abbreviatedNumber", "description": [ "// Because the implimentation for formatting large numbers is the same as formatting\n// bytes we are re-using the same code, we just format the number using the abbreviated number format." ], + "signature": [ + "(bytes: number) => string" + ], "source": { "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 19 }, - "signature": [ - "(bytes: number) => string" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "infra", "id": "def-public.FORMATTERS.bytes", "type": "Function", + "tags": [], "label": "bytes", "description": [ "// bytes in bytes formatted string out" ], + "signature": [ + "(bytes: number) => string" + ], "source": { "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 21 }, - "signature": [ - "(bytes: number) => string" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "infra", "id": "def-public.FORMATTERS.bits", "type": "Function", + "tags": [], "label": "bits", "description": [ "// bytes in bits formatted string out" ], + "signature": [ + "(bytes: number) => string" + ], "source": { "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 23 }, - "signature": [ - "(bytes: number) => string" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "infra", "id": "def-public.FORMATTERS.percent", "type": "Function", + "tags": [], "label": "percent", "description": [], + "signature": [ + "(val: number) => string" + ], "source": { "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 24 }, - "signature": [ - "(val: number) => string" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "infra", "id": "def-public.FORMATTERS.highPercision", "type": "Function", + "tags": [], "label": "highPercision", "description": [], + "signature": [ + "(val: number) => string" + ], "source": { "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 25 }, - "signature": [ - "(val: number) => string" - ] + "deprecated": false } ], - "description": [], - "label": "FORMATTERS", - "source": { - "path": "x-pack/plugins/infra/common/formatters/index.ts", - "lineNumber": 15 - }, "initialIsOpen": false } ] @@ -186,50 +209,73 @@ "enums": [], "misc": [ { + "parentPluginId": "infra", "id": "def-server.InfraConfig", "type": "Type", - "label": "InfraConfig", "tags": [], + "label": "InfraConfig", "description": [], + "signature": [ + "{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; container?: string | undefined; timestamp?: string | undefined; tiebreaker?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly inventory: Readonly<{} & { compositeSize: number; }>; }" + ], "source": { "path": "x-pack/plugins/infra/server/plugin.ts", - "lineNumber": 64 + "lineNumber": 65 }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "infra", + "id": "def-server.InfraRequestHandlerContext", + "type": "Type", + "tags": [], + "label": "InfraRequestHandlerContext", + "description": [], "signature": [ - "{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; timestamp?: string | undefined; container?: string | undefined; tiebreaker?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly inventory: Readonly<{} & { compositeSize: number; }>; }" + "InfraMlRequestHandlerContext & InfraSpacesRequestHandlerContext" ], + "source": { + "path": "x-pack/plugins/infra/server/types.ts", + "lineNumber": 24 + }, + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "infra", "id": "def-server.InfraPluginSetup", "type": "Interface", + "tags": [], "label": "InfraPluginSetup", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/infra/server/plugin.ts", + "lineNumber": 75 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "infra", "id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration", "type": "Function", + "tags": [], "label": "defineInternalSourceConfiguration", "description": [], - "source": { - "path": "x-pack/plugins/infra/server/plugin.ts", - "lineNumber": 75 - }, "signature": [ "(sourceId: string, sourceProperties: ", "InfraStaticSourceConfiguration", ") => void" - ] + ], + "source": { + "path": "x-pack/plugins/infra/server/plugin.ts", + "lineNumber": 76 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/infra/server/plugin.ts", - "lineNumber": 74 - }, "lifecycle": "setup", "initialIsOpen": true } diff --git a/api_docs/ingest_pipelines.json b/api_docs/ingest_pipelines.json index 27ca7ff70a436..3f8817a04ff3a 100644 --- a/api_docs/ingest_pipelines.json +++ b/api_docs/ingest_pipelines.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "ingestPipelines", "id": "def-public.IngestPipelinesUrlGenerator", "type": "Class", "tags": [], @@ -26,61 +27,95 @@ }, "<\"INGEST_PIPELINES_APP_URL_GENERATOR\">" ], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 55 + }, + "deprecated": false, "children": [ { + "parentPluginId": "ingestPipelines", "id": "def-public.IngestPipelinesUrlGenerator.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { + "parentPluginId": "ingestPipelines", "id": "def-public.IngestPipelinesUrlGenerator.Unnamed.$1", "type": "Function", + "tags": [], "label": "getAppBasePath", - "isRequired": true, + "description": [], "signature": [ "(absolute: boolean) => Promise" ], - "description": [], "source": { "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", - "lineNumber": 57 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "ingestPipelines", "id": "def-public.IngestPipelinesUrlGenerator.id", "type": "string", + "tags": [], "label": "id", "description": [], + "signature": [ + "\"INGEST_PIPELINES_APP_URL_GENERATOR\"" + ], "source": { "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", "lineNumber": 59 }, - "signature": [ - "\"INGEST_PIPELINES_APP_URL_GENERATOR\"" - ] + "deprecated": false }, { + "parentPluginId": "ingestPipelines", "id": "def-public.IngestPipelinesUrlGenerator.createUrl", "type": "Function", + "tags": [], + "label": "createUrl", + "description": [], + "signature": [ + "(state: ", + { + "pluginId": "ingestPipelines", + "scope": "public", + "docId": "kibIngestPipelinesPluginApi", + "section": "def-public.IngestPipelinesUrlGeneratorState", + "text": "IngestPipelinesUrlGeneratorState" + }, + ") => Promise" + ], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { + "parentPluginId": "ingestPipelines", "id": "def-public.IngestPipelinesUrlGenerator.createUrl.$1", "type": "CompoundType", + "tags": [], "label": "state", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "ingestPipelines", @@ -90,38 +125,17 @@ "text": "IngestPipelinesUrlGeneratorState" } ], - "description": [], "source": { "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(state: ", - { - "pluginId": "ingestPipelines", - "scope": "public", - "docId": "kibIngestPipelinesPluginApi", - "section": "def-public.IngestPipelinesUrlGeneratorState", - "text": "IngestPipelinesUrlGeneratorState" - }, - ") => Promise" - ], - "description": [], - "label": "createUrl", - "source": { - "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", - "lineNumber": 61 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", - "lineNumber": 55 - }, "initialIsOpen": false } ], @@ -129,44 +143,45 @@ "interfaces": [], "enums": [ { + "parentPluginId": "ingestPipelines", "id": "def-public.INGEST_PIPELINES_PAGES", "type": "Enum", - "label": "INGEST_PIPELINES_PAGES", "tags": [], + "label": "INGEST_PIPELINES_PAGES", "description": [], "source": { "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", "lineNumber": 22 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { - "tags": [], + "parentPluginId": "ingestPipelines", "id": "def-public.INGEST_PIPELINES_APP_ULR_GENERATOR", "type": "string", + "tags": [], "label": "INGEST_PIPELINES_APP_ULR_GENERATOR", "description": [], + "signature": [ + "\"INGEST_PIPELINES_APP_URL_GENERATOR\"" + ], "source": { "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", "lineNumber": 20 }, - "signature": [ - "\"INGEST_PIPELINES_APP_URL_GENERATOR\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "ingestPipelines", "id": "def-public.IngestPipelinesUrlGeneratorState", "type": "Type", - "label": "IngestPipelinesUrlGeneratorState", "tags": [], + "label": "IngestPipelinesUrlGeneratorState", "description": [], - "source": { - "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", - "lineNumber": 49 - }, "signature": [ "PipelinesListUrlGeneratorState", " | ", @@ -176,6 +191,11 @@ " | ", "PipelineCreateUrlGeneratorState" ], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 49 + }, + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/inspector.json b/api_docs/inspector.json index 051541f2f4ac0..776e7869e4fb8 100644 --- a/api_docs/inspector.json +++ b/api_docs/inspector.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "inspector", "id": "def-public.InspectorPublicPlugin", "type": "Class", "tags": [], @@ -42,36 +43,52 @@ }, ", object, object>" ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorPublicPlugin.views", "type": "Object", + "tags": [], "label": "views", "description": [], + "signature": [ + "InspectorViewRegistry", + " | undefined" + ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 55 }, - "signature": [ - "InspectorViewRegistry", - " | undefined" - ] + "deprecated": false }, { + "parentPluginId": "inspector", "id": "def-public.InspectorPublicPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.InspectorPublicPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -82,24 +99,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 57 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.InspectorPublicPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -121,13 +137,19 @@ "InspectorViewRegistry", "; }; }" ], - "description": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.InspectorPublicPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -138,24 +160,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 59 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.InspectorPublicPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -198,13 +219,19 @@ "text": "OverlayRef" } ], - "description": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 73 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.InspectorPublicPlugin.start.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -214,44 +241,39 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 73 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 73 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.InspectorPublicPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 114 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "inspector", "id": "def-public.RequestAdapter", "type": "Class", "tags": [ @@ -272,27 +294,41 @@ " extends ", "EventEmitter" ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestAdapter.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.RequestAdapter.start", "type": "Function", + "tags": [ + "return" + ], "label": "start", + "description": [ + "\nStart logging a new request into this request adapter. The new request will\nby default be in a processing state unless you explicitly finish it via\n{@link RequestResponder#finish}, {@link RequestResponder#ok} or\n{@link RequestResponder#error}.\n" + ], "signature": [ "(name: string, params?: ", "RequestParams", @@ -305,125 +341,132 @@ "text": "RequestResponder" } ], - "description": [ - "\nStart logging a new request into this request adapter. The new request will\nby default be in a processing state unless you explicitly finish it via\n{@link RequestResponder#finish}, {@link RequestResponder#ok} or\n{@link RequestResponder#error}.\n" - ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestAdapter.start.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "The name of this request as it should be shown in the UI." ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "inspector", "id": "def-public.RequestAdapter.start.$2", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "RequestParams" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "An instance to add information to the request and finish it." - ], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", - "lineNumber": 39 - } + ] }, { + "parentPluginId": "inspector", "id": "def-public.RequestAdapter.reset", "type": "Function", + "tags": [], "label": "reset", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 52 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.RequestAdapter.resetRequest", "type": "Function", + "tags": [], "label": "resetRequest", + "description": [], "signature": [ "(id: string) => void" ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestAdapter.resetRequest.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", - "lineNumber": 57 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.RequestAdapter.getRequests", "type": "Function", + "tags": [], "label": "getRequests", + "description": [], "signature": [ "() => ", "Request", "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 62 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "inspector", "id": "def-public.RequestResponder", "type": "Class", "tags": [], @@ -431,56 +474,72 @@ "description": [ "\nAn API to specify information about a specific request that will be logged.\nCreate a new instance to log a request using {@link RequestAdapter#start}." ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.Unnamed.$1", "type": "Object", + "tags": [], "label": "request", - "isRequired": true, + "description": [], "signature": [ "Request" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.Unnamed.$2", "type": "Function", + "tags": [], "label": "onChange", - "isRequired": true, + "description": [], "signature": [ "() => void" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 20 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.json", "type": "Function", + "tags": [], "label": "json", + "description": [], "signature": [ "(reqJson: object) => ", { @@ -491,34 +550,39 @@ "text": "RequestResponder" } ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.json.$1", "type": "Uncategorized", + "tags": [], "label": "reqJson", - "isRequired": true, + "description": [], "signature": [ "object" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 25 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.stats", "type": "Function", + "tags": [], "label": "stats", + "description": [], "signature": [ "(stats: ", { @@ -537,13 +601,19 @@ "text": "RequestResponder" } ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.stats.$1", "type": "Object", + "tags": [], "label": "stats", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "inspector", @@ -553,24 +623,23 @@ "text": "RequestStatistics" } ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 31 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.finish", "type": "Function", + "tags": [], "label": "finish", + "description": [], "signature": [ "(status: ", { @@ -584,13 +653,19 @@ "Response", ") => void" ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.finish.$1", "type": "Enum", + "tags": [], "label": "status", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "inspector", @@ -600,129 +675,137 @@ "text": "RequestStatus" } ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.finish.$2", "type": "Object", + "tags": [], "label": "response", - "isRequired": true, + "description": [], "signature": [ "Response" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 53 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.ok", "type": "Function", + "tags": [], "label": "ok", + "description": [], "signature": [ "(response: ", "Response", ") => void" ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.ok.$1", "type": "Object", + "tags": [], "label": "response", - "isRequired": true, + "description": [], "signature": [ "Response" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 60 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.error", "type": "Function", + "tags": [], "label": "error", + "description": [], "signature": [ "(response: ", "Response", ") => void" ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestResponder.error.$1", "type": "Object", + "tags": [], "label": "response", - "isRequired": true, + "description": [], "signature": [ "Response" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 64 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 64 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 16 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "inspector", "id": "def-public.Adapters", "type": "Interface", + "tags": [], "label": "Adapters", "description": [ "\nThe interface that the adapters used to open an inspector have to fullfill." ], - "tags": [], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.Adapters.requests", "type": "Object", + "tags": [], "label": "requests", "description": [], - "source": { - "path": "src/plugins/inspector/common/adapters/types.ts", - "lineNumber": 15 - }, "signature": [ { "pluginId": "inspector", @@ -732,96 +815,109 @@ "text": "RequestAdapter" }, " | undefined" - ] - }, - { - "id": "def-public.Adapters.Unnamed", + ], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 15 + }, + "deprecated": false + }, + { + "parentPluginId": "inspector", + "id": "def-public.Adapters.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 16 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/common/adapters/types.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "inspector", "id": "def-public.InspectorOptions", "type": "Interface", + "tags": [ + "property", + "property" + ], "label": "InspectorOptions", "description": [ "\nOptions that can be specified when opening the inspector." ], - "tags": [ - "property" - ], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorOptions.title", "type": "string", + "tags": [], "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 60 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorOptions.options", "type": "Unknown", + "tags": [], "label": "options", "description": [], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 61 }, - "signature": [ - "unknown" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 59 - }, "initialIsOpen": false }, { + "parentPluginId": "inspector", "id": "def-public.InspectorViewDescription", "type": "Interface", + "tags": [ + "typedef" + ], "label": "InspectorViewDescription", "description": [ "\nAn object describing an inspector view." ], - "tags": [ - "typedef" - ], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorViewDescription.component", "type": "CompoundType", + "tags": [], "label": "component", "description": [], - "source": { - "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 46 - }, "signature": [ "React.ComponentType<", { @@ -840,46 +936,52 @@ "text": "Adapters" }, ">>" - ] + ], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 46 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorViewDescription.help", "type": "string", + "tags": [], "label": "help", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 47 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorViewDescription.order", "type": "number", + "tags": [], "label": "order", "description": [], + "signature": [ + "number | undefined" + ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 48 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorViewDescription.shouldShow", "type": "Function", + "tags": [], "label": "shouldShow", "description": [], - "source": { - "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 49 - }, "signature": [ "((adapters: ", { @@ -890,30 +992,38 @@ "text": "Adapters" }, ") => boolean) | undefined" - ] + ], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 49 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorViewDescription.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 50 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 45 - }, "initialIsOpen": false }, { + "parentPluginId": "inspector", "id": "def-public.InspectorViewProps", "type": "Interface", + "tags": [], "label": "InspectorViewProps", + "description": [ + "\nThe props interface that a custom inspector view component, that will be passed\nto {@link InspectorViewDescription#component}, must use." + ], "signature": [ { "pluginId": "inspector", @@ -924,31 +1034,35 @@ }, "" ], - "description": [ - "\nThe props interface that a custom inspector view component, that will be passed\nto {@link InspectorViewDescription#component}, must use." - ], - "tags": [], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorViewProps.adapters", "type": "Uncategorized", + "tags": [], "label": "adapters", "description": [ "\nAdapters used to open the inspector." ], + "signature": [ + "TAdapters" + ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 20 }, - "signature": [ - "TAdapters" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorViewProps.title", "type": "string", + "tags": [], "label": "title", "description": [ "\nThe title that the inspector is currently using e.g. a visualization name." @@ -956,119 +1070,131 @@ "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.InspectorViewProps.options", "type": "Unknown", + "tags": [], "label": "options", "description": [ "\nA set of specific options for each view." ], + "signature": [ + "unknown" + ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 28 }, - "signature": [ - "unknown" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "inspector", "id": "def-public.RequestStatistic", "type": "Interface", + "tags": [], "label": "RequestStatistic", "description": [], - "tags": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.RequestStatistic.label", "type": "string", + "tags": [], "label": "label", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 49 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.RequestStatistic.description", "type": "string", + "tags": [], "label": "description", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 50 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.RequestStatistic.value", "type": "Any", + "tags": [], "label": "value", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 51 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/common/adapters/request/types.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "inspector", "id": "def-public.RequestStatistics", "type": "Interface", + "tags": [], "label": "RequestStatistics", "description": [], - "tags": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-public.RequestStatistics.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 45 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/common/adapters/request/types.ts", - "lineNumber": 44 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "inspector", "id": "def-public.RequestStatus", "type": "Enum", - "label": "RequestStatus", "tags": [], + "label": "RequestStatus", "description": [ "\nThe status a request can have." ], @@ -1076,44 +1202,50 @@ "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 12 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { + "parentPluginId": "inspector", "id": "def-public.InspectorSession", "type": "Type", - "label": "InspectorSession", "tags": [], + "label": "InspectorSession", "description": [], + "signature": [ + "OverlayRef" + ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 64 }, - "signature": [ - "OverlayRef" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { + "parentPluginId": "inspector", "id": "def-public.Setup", "type": "Interface", + "tags": [], "label": "Setup", "description": [], - "tags": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.Setup.registerView", "type": "Function", + "tags": [], "label": "registerView", "description": [], - "source": { - "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 21 - }, "signature": [ "(view: ", { @@ -1124,51 +1256,57 @@ "text": "InspectorViewDescription" }, ") => void" - ] + ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 21 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.Setup.__LEGACY", "type": "Object", + "tags": [], "label": "__LEGACY", "description": [], - "source": { - "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 23 - }, "signature": [ "{ views: ", "InspectorViewRegistry", "; }" - ] + ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 23 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 20 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "inspector", "id": "def-public.Start", "type": "Interface", + "tags": [], "label": "Start", "description": [], - "tags": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "inspector", "id": "def-public.Start.isAvailable", "type": "Function", + "tags": [], "label": "isAvailable", "description": [ "\nChecks if a inspector panel could be shown based on the passed adapters.\n" ], - "source": { - "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 37 - }, "signature": [ "(adapters?: ", { @@ -1179,23 +1317,25 @@ "text": "Adapters" }, " | undefined) => boolean" - ] + ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 37 + }, + "deprecated": false }, { + "parentPluginId": "inspector", + "id": "def-public.Start.open", + "type": "Function", "tags": [ "return", "throws" ], - "id": "def-public.Start.open", - "type": "Function", "label": "open", "description": [ "\nOpens the inspector panel for the given adapters and close any previously opened\ninspector panel. The previously panel will be closed also if no new panel will be\nopened (e.g. because of the passed adapters no view is available). You can use\n{@link InspectorSession#close} on the return value to close that opened panel again.\n" ], - "source": { - "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 51 - }, "signature": [ "(adapters: ", { @@ -1221,13 +1361,14 @@ "section": "def-public.OverlayRef", "text": "OverlayRef" } - ] + ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 51 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 28 - }, "lifecycle": "start", "initialIsOpen": true } @@ -1243,6 +1384,7 @@ "common": { "classes": [ { + "parentPluginId": "inspector", "id": "def-common.RequestAdapter", "type": "Class", "tags": [ @@ -1263,27 +1405,41 @@ " extends ", "EventEmitter" ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestAdapter.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-common.RequestAdapter.start", "type": "Function", + "tags": [ + "return" + ], "label": "start", + "description": [ + "\nStart logging a new request into this request adapter. The new request will\nby default be in a processing state unless you explicitly finish it via\n{@link RequestResponder#finish}, {@link RequestResponder#ok} or\n{@link RequestResponder#error}.\n" + ], "signature": [ "(name: string, params?: ", "RequestParams", @@ -1296,125 +1452,132 @@ "text": "RequestResponder" } ], - "description": [ - "\nStart logging a new request into this request adapter. The new request will\nby default be in a processing state unless you explicitly finish it via\n{@link RequestResponder#finish}, {@link RequestResponder#ok} or\n{@link RequestResponder#error}.\n" - ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestAdapter.start.$1", "type": "string", + "tags": [], "label": "name", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "The name of this request as it should be shown in the UI." ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "inspector", "id": "def-common.RequestAdapter.start.$2", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ "RequestParams" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "An instance to add information to the request and finish it." - ], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", - "lineNumber": 39 - } + ] }, { + "parentPluginId": "inspector", "id": "def-common.RequestAdapter.reset", "type": "Function", + "tags": [], "label": "reset", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 52 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-common.RequestAdapter.resetRequest", "type": "Function", + "tags": [], "label": "resetRequest", + "description": [], "signature": [ "(id: string) => void" ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 57 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestAdapter.resetRequest.$1", "type": "string", + "tags": [], "label": "id", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", - "lineNumber": 57 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-common.RequestAdapter.getRequests", "type": "Function", + "tags": [], "label": "getRequests", + "description": [], "signature": [ "() => ", "Request", "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 62 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "inspector", "id": "def-common.RequestResponder", "type": "Class", "tags": [], @@ -1422,56 +1585,72 @@ "description": [ "\nAn API to specify information about a specific request that will be logged.\nCreate a new instance to log a request using {@link RequestAdapter#start}." ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.Unnamed.$1", "type": "Object", + "tags": [], "label": "request", - "isRequired": true, + "description": [], "signature": [ "Request" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.Unnamed.$2", "type": "Function", + "tags": [], "label": "onChange", - "isRequired": true, + "description": [], "signature": [ "() => void" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 20 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.json", "type": "Function", + "tags": [], "label": "json", + "description": [], "signature": [ "(reqJson: object) => ", { @@ -1482,34 +1661,39 @@ "text": "RequestResponder" } ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 25 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.json.$1", "type": "Uncategorized", + "tags": [], "label": "reqJson", - "isRequired": true, + "description": [], "signature": [ "object" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 25 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 25 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.stats", "type": "Function", + "tags": [], "label": "stats", + "description": [], "signature": [ "(stats: ", { @@ -1528,13 +1712,19 @@ "text": "RequestResponder" } ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 31 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.stats.$1", "type": "Object", + "tags": [], "label": "stats", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "inspector", @@ -1544,24 +1734,23 @@ "text": "RequestStatistics" } ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 31 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.finish", "type": "Function", + "tags": [], "label": "finish", + "description": [], "signature": [ "(status: ", { @@ -1575,13 +1764,19 @@ "Response", ") => void" ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 53 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.finish.$1", "type": "Enum", + "tags": [], "label": "status", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "inspector", @@ -1591,129 +1786,137 @@ "text": "RequestStatus" } ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.finish.$2", "type": "Object", + "tags": [], "label": "response", - "isRequired": true, + "description": [], "signature": [ "Response" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 53 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 53 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.ok", "type": "Function", + "tags": [], "label": "ok", + "description": [], "signature": [ "(response: ", "Response", ") => void" ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.ok.$1", "type": "Object", + "tags": [], "label": "response", - "isRequired": true, + "description": [], "signature": [ "Response" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 60 - } + "returnComment": [] }, { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.error", "type": "Function", + "tags": [], "label": "error", + "description": [], "signature": [ "(response: ", "Response", ") => void" ], - "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestResponder.error.$1", "type": "Object", + "tags": [], "label": "response", - "isRequired": true, + "description": [], "signature": [ "Response" ], - "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 64 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 64 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", - "lineNumber": 16 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "inspector", "id": "def-common.Adapters", "type": "Interface", + "tags": [], "label": "Adapters", "description": [ "\nThe interface that the adapters used to open an inspector have to fullfill." ], - "tags": [], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "inspector", "id": "def-common.Adapters.requests", "type": "Object", + "tags": [], "label": "requests", "description": [], - "source": { - "path": "src/plugins/inspector/common/adapters/types.ts", - "lineNumber": 15 - }, "signature": [ { "pluginId": "inspector", @@ -1723,117 +1926,133 @@ "text": "RequestAdapter" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 15 + }, + "deprecated": false }, { + "parentPluginId": "inspector", "id": "def-common.Adapters.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 16 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/common/adapters/types.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "inspector", "id": "def-common.RequestStatistic", "type": "Interface", + "tags": [], "label": "RequestStatistic", "description": [], - "tags": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 48 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "inspector", "id": "def-common.RequestStatistic.label", "type": "string", + "tags": [], "label": "label", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 49 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-common.RequestStatistic.description", "type": "string", + "tags": [], "label": "description", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 50 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "inspector", "id": "def-common.RequestStatistic.value", "type": "Any", + "tags": [], "label": "value", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 51 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/common/adapters/request/types.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "inspector", "id": "def-common.RequestStatistics", "type": "Interface", + "tags": [], "label": "RequestStatistics", "description": [], - "tags": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 44 + }, + "deprecated": false, "children": [ { + "parentPluginId": "inspector", "id": "def-common.RequestStatistics.Unnamed", "type": "Any", - "label": "Unnamed", "tags": [], + "label": "Unnamed", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 45 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/inspector/common/adapters/request/types.ts", - "lineNumber": 44 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "inspector", "id": "def-common.RequestStatus", "type": "Enum", - "label": "RequestStatus", "tags": [], + "label": "RequestStatus", "description": [ "\nThe status a request can have." ], @@ -1841,6 +2060,7 @@ "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 12 }, + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/kibana_legacy.json b/api_docs/kibana_legacy.json index 2e4b8be78dcf3..b868b189a5c87 100644 --- a/api_docs/kibana_legacy.json +++ b/api_docs/kibana_legacy.json @@ -3,26 +3,41 @@ "client": { "classes": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.KibanaLegacyPlugin", "type": "Class", "tags": [], "label": "KibanaLegacyPlugin", "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.KibanaLegacyPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.KibanaLegacyPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -33,24 +48,23 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/plugin.ts", "lineNumber": 15 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/plugin.ts", - "lineNumber": 15 - } + "returnComment": [] }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.KibanaLegacyPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -64,13 +78,19 @@ "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }>) => {}" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.KibanaLegacyPlugin.setup.$1", "type": "Object", + "tags": [], "label": "core", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -83,24 +103,23 @@ "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }>" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/plugin.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/plugin.ts", - "lineNumber": 17 - } + "returnComment": [] }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.KibanaLegacyPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "({ application, http: { basePath }, uiSettings }: ", { @@ -114,13 +133,19 @@ "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.KibanaLegacyPlugin.start.$1", "type": "Object", + "tags": [], "label": "{ application, http: { basePath }, uiSettings }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -130,44 +155,39 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/plugin.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/plugin.ts", - "lineNumber": 21 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/kibana_legacy/public/plugin.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.ToastNotifications", "type": "Class", "tags": [], "label": "ToastNotifications", "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 11 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.ToastNotifications.list", "type": "Array", + "tags": [], "label": "list", "description": [], - "source": { - "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 12 - }, "signature": [ { "pluginId": "core", @@ -177,22 +197,36 @@ "text": "Toast" }, "[]" - ] + ], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 12 + }, + "deprecated": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.ToastNotifications.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.ToastNotifications.Unnamed.$1", "type": "Object", + "tags": [], "label": "toasts", - "isRequired": true, + "description": [], "signature": [ "Pick<", { @@ -204,76 +238,59 @@ }, ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 16 - } + "returnComment": [] }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.ToastNotifications.onChange", "type": "Function", + "tags": [], + "label": "onChange", + "description": [], + "signature": [ + "(callback: () => void) => void" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.ToastNotifications.onChange.$1", "type": "Function", + "tags": [], "label": "callback", - "isRequired": true, + "description": [], "signature": [ "() => void" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(callback: () => void) => void" - ], - "description": [], - "label": "onChange", - "source": { - "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 26 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.ToastNotifications.add", "type": "Function", - "children": [ - { - "id": "def-public.ToastNotifications.add.$1", - "type": "CompoundType", - "label": "toastOrTitle", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - } - ], - "description": [], - "source": { - "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 30 - } - } - ], + "tags": [], + "label": "add", + "description": [], "signature": [ "(toastOrTitle: ", { @@ -292,40 +309,45 @@ "text": "Toast" } ], - "description": [], - "label": "add", "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", "lineNumber": 30 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ToastNotifications.remove", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.ToastNotifications.remove.$1", + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.add.$1", "type": "CompoundType", - "label": "toast", - "isRequired": true, + "tags": [], + "label": "toastOrTitle", + "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastInput", + "text": "ToastInput" } ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 31 - } + "lineNumber": 30 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [], "signature": [ "(toast: ", { @@ -337,40 +359,45 @@ }, ") => void" ], - "description": [], - "label": "remove", "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", "lineNumber": 31 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ToastNotifications.addSuccess", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.ToastNotifications.addSuccess.$1", + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.remove.$1", "type": "CompoundType", - "label": "toastOrTitle", - "isRequired": true, + "tags": [], + "label": "toast", + "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.Toast", + "text": "Toast" } ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 32 - } + "lineNumber": 31 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.addSuccess", + "type": "Function", + "tags": [], + "label": "addSuccess", + "description": [], "signature": [ "(toastOrTitle: ", { @@ -389,24 +416,19 @@ "text": "Toast" } ], - "description": [], - "label": "addSuccess", "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", "lineNumber": 32 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ToastNotifications.addWarning", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.ToastNotifications.addWarning.$1", + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.addSuccess.$1", "type": "CompoundType", + "tags": [], "label": "toastOrTitle", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -416,13 +438,23 @@ "text": "ToastInput" } ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 33 - } + "lineNumber": 32 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.addWarning", + "type": "Function", + "tags": [], + "label": "addWarning", + "description": [], "signature": [ "(toastOrTitle: ", { @@ -441,24 +473,19 @@ "text": "Toast" } ], - "description": [], - "label": "addWarning", "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", "lineNumber": 33 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ToastNotifications.addDanger", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.ToastNotifications.addDanger.$1", + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.addWarning.$1", "type": "CompoundType", + "tags": [], "label": "toastOrTitle", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -468,13 +495,23 @@ "text": "ToastInput" } ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 34 - } + "lineNumber": 33 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.addDanger", + "type": "Function", + "tags": [], + "label": "addDanger", + "description": [], "signature": [ "(toastOrTitle: ", { @@ -493,54 +530,45 @@ "text": "Toast" } ], - "description": [], - "label": "addDanger", "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", "lineNumber": 34 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ToastNotifications.addError", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.ToastNotifications.addError.$1", - "type": "Object", - "label": "error", - "isRequired": true, - "signature": [ - "Error" - ], + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.addDanger.$1", + "type": "CompoundType", + "tags": [], + "label": "toastOrTitle", "description": [], - "source": { - "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 35 - } - }, - { - "id": "def-public.ToastNotifications.addError.$2", - "type": "Object", - "label": "options", - "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" + "section": "def-public.ToastInput", + "text": "ToastInput" } ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 35 - } + "lineNumber": 34 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [] + }, + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.addError", + "type": "Function", + "tags": [], + "label": "addError", + "description": [], "signature": [ "(error: Error, options: ", { @@ -559,60 +587,104 @@ "text": "Toast" } ], - "description": [], - "label": "addError", "source": { "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", "lineNumber": 35 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.addError.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 35 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.ToastNotifications.addError.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + } + ], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 35 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } ], - "source": { - "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", - "lineNumber": 11 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.$setupXsrfRequestInterceptor", "type": "Function", + "tags": [], + "label": "$setupXsrfRequestInterceptor", + "description": [], + "signature": [ + "(version: string) => ($httpProvider: angular.IHttpProvider) => void" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 136 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.$setupXsrfRequestInterceptor.$1", "type": "string", + "tags": [], "label": "version", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 136 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(version: string) => ($httpProvider: angular.IHttpProvider) => void" - ], - "description": [], - "label": "$setupXsrfRequestInterceptor", - "source": { - "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", - "lineNumber": 136 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.addFatalError", "type": "Function", + "tags": [], "label": "addFatalError", + "description": [], "signature": [ "(fatalErrors: ", { @@ -632,13 +704,19 @@ }, ", location: string | undefined) => void" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.addFatalError.$1", "type": "Object", + "tags": [], "label": "fatalErrors", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -648,17 +726,20 @@ "text": "FatalErrorsSetup" } ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.addFatalError.$2", "type": "CompoundType", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "string | Error | ", { @@ -669,110 +750,146 @@ "text": "AngularHttpError" } ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.addFatalError.$3", "type": "string", + "tags": [], "label": "location", - "isRequired": false, + "description": [], "signature": [ "string | undefined" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.addSystemApiHeader", "type": "Function", - "label": "addSystemApiHeader", - "signature": [ - "(originalHeaders: Record) => { \"kbn-system-request\": boolean; }" + "tags": [ + "return" ], + "label": "addSystemApiHeader", "description": [ "\nAdds a custom header designating request as system API" ], + "signature": [ + "(originalHeaders: Record) => { \"kbn-system-request\": boolean; }" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/utils/system_api.ts", + "lineNumber": 19 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.addSystemApiHeader.$1", "type": "Object", + "tags": [], "label": "originalHeaders", - "isRequired": true, - "signature": [ - "Record" - ], "description": [ "Object representing set of headers" ], + "signature": [ + "Record" + ], "source": { "path": "src/plugins/kibana_legacy/public/utils/system_api.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "Object representing set of headers, with system API header added in" ], - "source": { - "path": "src/plugins/kibana_legacy/public/utils/system_api.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.configureAppAngularModule", "type": "Function", + "tags": [], + "label": "configureAppAngularModule", + "description": [], + "signature": [ + "(angularModule: angular.IModule, newPlatform: { core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + "; readonly env: { mode: Readonly<", + "EnvironmentMode", + ">; packageInfo: Readonly<", + "PackageInfo", + ">; }; }, isLocalAngular: boolean, getHistory?: (() => ", + "History", + ") | undefined) => void" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 62 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.configureAppAngularModule.$1", "type": "Object", + "tags": [], "label": "angularModule", - "isRequired": true, + "description": [], "signature": [ "angular.IModule" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 63 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.configureAppAngularModule.$2.newPlatform", "type": "Object", - "label": "newPlatform", "tags": [], + "label": "newPlatform", "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 64 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.configureAppAngularModule.$2.newPlatform.core", "type": "Object", + "tags": [], "label": "core", "description": [], - "source": { - "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", - "lineNumber": 65 - }, "signature": [ { "pluginId": "core", @@ -781,109 +898,99 @@ "section": "def-public.CoreStart", "text": "CoreStart" } - ] + ], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 65 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.configureAppAngularModule.$2.newPlatform.env", "type": "Object", + "tags": [], "label": "env", "description": [], - "source": { - "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", - "lineNumber": 66 - }, "signature": [ "{ mode: Readonly<", "EnvironmentMode", ">; packageInfo: Readonly<", "PackageInfo", ">; }" - ] + ], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 66 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", - "lineNumber": 64 - } + ] }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.configureAppAngularModule.$3", "type": "boolean", + "tags": [], "label": "isLocalAngular", - "isRequired": true, + "description": [], "signature": [ "boolean" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 71 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.configureAppAngularModule.$4", "type": "Function", + "tags": [], "label": "getHistory", - "isRequired": false, + "description": [], "signature": [ "(() => ", "History", ") | undefined" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 72 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(angularModule: angular.IModule, newPlatform: { core: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - }, - "; readonly env: { mode: Readonly<", - "EnvironmentMode", - ">; packageInfo: Readonly<", - "PackageInfo", - ">; }; }, isLocalAngular: boolean, getHistory?: (() => ", - "History", - ") | undefined) => void" - ], - "description": [], - "label": "configureAppAngularModule", - "source": { - "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", - "lineNumber": 62 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.createTopNavHelper", "type": "Function", + "tags": [], "label": "createTopNavHelper", "description": [], + "signature": [ + "(options: unknown) => angular.Injectable>" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", "lineNumber": 14 }, - "signature": [ - "(options: unknown) => angular.Injectable>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.formatAngularHttpError", "type": "Function", + "tags": [], "label": "formatAngularHttpError", + "description": [], "signature": [ "(error: ", { @@ -895,13 +1002,19 @@ }, ") => string" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.formatAngularHttpError.$1", "type": "Object", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaLegacy", @@ -911,418 +1024,479 @@ "text": "AngularHttpError" } ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", "lineNumber": 24 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.formatESMsg", "type": "Function", + "tags": [], + "label": "formatESMsg", + "description": [ + "\nUtilize the extended error information returned from elasticsearch" + ], + "signature": [ + "(err: string | Record) => string | undefined" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.formatESMsg.$1", "type": "CompoundType", + "tags": [], "label": "err", - "isRequired": true, + "description": [], "signature": [ "string | Record" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(err: string | Record) => string | undefined" - ], - "description": [ - "\nUtilize the extended error information returned from elasticsearch" - ], - "label": "formatESMsg", - "source": { - "path": "src/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts", - "lineNumber": 18 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.formatMsg", "type": "Function", + "tags": [], "label": "formatMsg", - "signature": [ - "(err: string | Record, source: string) => string" - ], "description": [ "\nFormats the error message from an error object, extended elasticsearch\nobject or simple string; prepends optional second parameter to the message" ], + "signature": [ + "(err: string | Record, source: string) => string" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_msg.ts", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.formatMsg.$1", "type": "CompoundType", + "tags": [], "label": "err", - "isRequired": true, + "description": [], "signature": [ "string | Record" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_msg.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.formatMsg.$2", "type": "string", + "tags": [], "label": "source", - "isRequired": true, - "signature": [ - "string" - ], "description": [ "- Prefix for message indicating source (optional)" ], + "signature": [ + "string" + ], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_msg.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/notify/lib/format_msg.ts", - "lineNumber": 21 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.formatStack", "type": "Function", + "tags": [], "label": "formatStack", + "description": [], "signature": [ "(err: Record) => any" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_stack.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.formatStack.$1", "type": "Object", + "tags": [], "label": "err", - "isRequired": true, + "description": [], "signature": [ "Record" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_stack.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/notify/lib/format_stack.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.initAngularBootstrap", "type": "Function", + "tags": [], "label": "initAngularBootstrap", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular_bootstrap/index.ts", "lineNumber": 15 }, - "signature": [ - "() => void" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.isAngularHttpError", "type": "Function", + "tags": [], "label": "isAngularHttpError", + "description": [], "signature": [ "(error: any) => boolean" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.isAngularHttpError.$1", "type": "Any", + "tags": [], "label": "error", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.isSystemApiRequest", "type": "Function", - "label": "isSystemApiRequest", - "signature": [ - "(request: angular.IRequestConfig) => boolean | undefined" + "tags": [ + "return" ], + "label": "isSystemApiRequest", "description": [ "\nReturns true if request is a system API request; false otherwise\n" ], + "signature": [ + "(request: angular.IRequestConfig) => boolean | undefined" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/utils/system_api.ts", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.isSystemApiRequest.$1", "type": "Object", + "tags": [], "label": "request", - "isRequired": true, - "signature": [ - "angular.IRequestConfig" - ], "description": [ "Object Request object created by $http service" ], + "signature": [ + "angular.IRequestConfig" + ], "source": { "path": "src/plugins/kibana_legacy/public/utils/system_api.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "true if request is a system API request; false otherwise" ], - "source": { - "path": "src/plugins/kibana_legacy/public/utils/system_api.ts", - "lineNumber": 35 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.loadKbnTopNavDirectives", "type": "Function", + "tags": [], "label": "loadKbnTopNavDirectives", + "description": [], "signature": [ "(navUi: unknown) => void" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", + "lineNumber": 17 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.loadKbnTopNavDirectives.$1", "type": "Unknown", + "tags": [], "label": "navUi", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", - "lineNumber": 17 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.PaginateControlsDirectiveProvider", "type": "Function", + "tags": [], "label": "PaginateControlsDirectiveProvider", + "description": [], "signature": [ "() => any" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", "lineNumber": 10 }, + "deprecated": false, + "children": [], + "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.PaginateDirectiveProvider", "type": "Function", + "tags": [], "label": "PaginateDirectiveProvider", + "description": [], "signature": [ "($parse: any, $compile: any) => any" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.PaginateDirectiveProvider.$1", "type": "Any", + "tags": [], "label": "$parse", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.PaginateDirectiveProvider.$2", "type": "Any", + "tags": [], "label": "$compile", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.PrivateProvider", "type": "Function", + "tags": [], "label": "PrivateProvider", + "description": [], "signature": [ "() => angular.IServiceProvider" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_legacy/public/utils/private.d.ts", "lineNumber": 13 }, + "deprecated": false, + "children": [], + "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.PromiseServiceCreator", "type": "Function", + "tags": [], "label": "PromiseServiceCreator", + "description": [], "signature": [ "($q: unknown, $timeout: unknown) => (fn: unknown) => unknown" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/promises.d.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.PromiseServiceCreator.$1", "type": "Unknown", + "tags": [], "label": "$q", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/promises.d.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.PromiseServiceCreator.$2", "type": "Unknown", + "tags": [], "label": "$timeout", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/promises.d.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/angular/promises.d.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.registerListenEventListener", "type": "Function", + "tags": [], "label": "registerListenEventListener", + "description": [], "signature": [ "($rootScope: unknown) => void" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.registerListenEventListener.$1", "type": "Unknown", + "tags": [], "label": "$rootScope", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.subscribeWithScope", "type": "Function", + "tags": [], "label": "subscribeWithScope", + "description": [ + "\nSubscribe to an observable at a $scope, ensuring that the digest cycle\nis run for subscriber hooks and routing errors to fatalError if not handled." + ], "signature": [ "($scope: angular.IScope, observable: ", "Observable", @@ -1335,44 +1509,54 @@ " | undefined, fatalError: FatalErrorFn | undefined) => ", "Subscription" ], - "description": [ - "\nSubscribe to an observable at a $scope, ensuring that the digest cycle\nis run for subscriber hooks and routing errors to fatalError if not handled." - ], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.subscribeWithScope.$1", "type": "Object", + "tags": [], "label": "$scope", - "isRequired": true, + "description": [], "signature": [ "angular.IScope" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", "lineNumber": 40 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.subscribeWithScope.$2", "type": "Object", + "tags": [], "label": "observable", - "isRequired": true, + "description": [], "signature": [ "Observable", "" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.subscribeWithScope.$3", "type": "CompoundType", + "tags": [], "label": "observer", - "isRequired": false, + "description": [], "signature": [ "NextObserver", " | ", @@ -1381,318 +1565,356 @@ "CompletionObserver", " | undefined" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.subscribeWithScope.$4", "type": "Function", + "tags": [], "label": "fatalError", - "isRequired": false, + "description": [], "signature": [ "FatalErrorFn | undefined" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", - "lineNumber": 39 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.watchMultiDecorator", "type": "Function", + "tags": [], "label": "watchMultiDecorator", + "description": [], "signature": [ "($provide: unknown) => void" ], - "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts", + "lineNumber": 9 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.watchMultiDecorator.$1", "type": "Unknown", + "tags": [], "label": "$provide", - "isRequired": true, + "description": [], "signature": [ "unknown" ], - "description": [], "source": { "path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts", "lineNumber": 9 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts", - "lineNumber": 9 - }, "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration", "type": "Interface", + "tags": [], "label": "RouteConfiguration", "description": [], - "tags": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration.controller", "type": "CompoundType", + "tags": [], "label": "controller", "description": [], + "signature": [ + "string | ((...args: any[]) => void) | undefined" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 29 }, - "signature": [ - "string | ((...args: any[]) => void) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration.redirectTo", "type": "string", + "tags": [], "label": "redirectTo", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 30 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration.resolveRedirectTo", "type": "Function", + "tags": [], "label": "resolveRedirectTo", "description": [], + "signature": [ + "((...args: any[]) => void) | undefined" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 31 }, - "signature": [ - "((...args: any[]) => void) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration.reloadOnSearch", "type": "CompoundType", + "tags": [], "label": "reloadOnSearch", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 32 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration.reloadOnUrl", "type": "CompoundType", + "tags": [], "label": "reloadOnUrl", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 33 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration.outerAngularWrapperRoute", "type": "CompoundType", + "tags": [], "label": "outerAngularWrapperRoute", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 34 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration.resolve", "type": "Uncategorized", + "tags": [], "label": "resolve", "description": [], + "signature": [ + "object | undefined" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 35 }, - "signature": [ - "object | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration.template", "type": "string", + "tags": [], "label": "template", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 36 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration.k7Breadcrumbs", "type": "Function", + "tags": [], "label": "k7Breadcrumbs", "description": [], - "source": { - "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", - "lineNumber": 37 - }, "signature": [ "((...args: any[]) => ", "EuiBreadcrumb", "[]) | undefined" - ] + ], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 37 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.RouteConfiguration.requireUICapability", "type": "string", + "tags": [], "label": "requireUICapability", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", "lineNumber": 38 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", - "lineNumber": 28 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "kibanaLegacy", "id": "def-public.AngularHttpError", "type": "Type", - "label": "AngularHttpError", "tags": [], + "label": "AngularHttpError", "description": [], + "signature": [ + "IHttpResponse<{ message: string; }>" + ], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", "lineNumber": 12 }, - "signature": [ - "IHttpResponse<{ message: string; }>" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.createTopNavDirective", "type": "CompoundType", + "tags": [], "label": "createTopNavDirective", "description": [], + "signature": [ + "angular.Injectable>" + ], "source": { "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", "lineNumber": 11 }, - "signature": [ - "angular.Injectable>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.IPrivate", "type": "Type", - "label": "IPrivate", "tags": [], + "label": "IPrivate", "description": [], + "signature": [ + "(provider: (...injectable: any[]) => T) => T" + ], "source": { "path": "src/plugins/kibana_legacy/public/utils/private.d.ts", "lineNumber": 11 }, - "signature": [ - "(provider: (...injectable: any[]) => T) => T" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "kibanaLegacy", "id": "def-public.KbnAccessibleClickProvider", "type": "CompoundType", + "tags": [], "label": "KbnAccessibleClickProvider", "description": [], + "signature": [ + "angular.Injectable>" + ], "source": { "path": "src/plugins/kibana_legacy/public/utils/kbn_accessible_click.d.ts", "lineNumber": 11 }, - "signature": [ - "angular.Injectable>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.KibanaLegacySetup", "type": "Type", - "label": "KibanaLegacySetup", "tags": [], + "label": "KibanaLegacySetup", "description": [], + "signature": [ + "{}" + ], "source": { "path": "src/plugins/kibana_legacy/public/plugin.ts", "lineNumber": 45 }, - "signature": [ - "{}" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "kibanaLegacy", "id": "def-public.KibanaLegacyStart", "type": "Type", - "label": "KibanaLegacyStart", "tags": [], + "label": "KibanaLegacyStart", "description": [], - "source": { - "path": "src/plugins/kibana_legacy/public/plugin.ts", - "lineNumber": 46 - }, "signature": [ "{ dashboardConfig: ", "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }" ], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 46 + }, + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/kibana_react.json b/api_docs/kibana_react.json index 1085cf8f14bbd..1918c347e180e 100644 --- a/api_docs/kibana_react.json +++ b/api_docs/kibana_react.json @@ -3,6 +3,7 @@ "client": { "classes": [ { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView", "type": "Class", "tags": [], @@ -34,21 +35,35 @@ }, ", any>" ], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 86 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 90 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.Unnamed.$1", "type": "Object", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaReact", @@ -58,355 +73,390 @@ "text": "TableListViewProps" } ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 90 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 90 - } + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.UNSAFE_componentWillMount", "type": "Function", + "tags": [], "label": "UNSAFE_componentWillMount", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 111 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.componentWillUnmount", "type": "Function", + "tags": [], "label": "componentWillUnmount", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 115 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.componentDidMount", "type": "Function", + "tags": [], "label": "componentDidMount", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 120 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { - "tags": [], + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.debouncedFetch", "type": "Function", + "tags": [], "label": "debouncedFetch", "description": [], + "signature": [ + "((filter: string) => Promise) & _.Cancelable" + ], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 124 }, - "signature": [ - "((filter: string) => Promise) & _.Cancelable" - ] + "deprecated": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.fetchItems", "type": "Function", - "children": [], + "tags": [], + "label": "fetchItems", + "description": [], "signature": [ "() => void" ], - "description": [], - "label": "fetchItems", "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 156 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.deleteSelectedItems", "type": "Function", - "children": [], + "tags": [], + "label": "deleteSelectedItems", + "description": [], "signature": [ "() => Promise" ], - "description": [], - "label": "deleteSelectedItems", "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 166 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.closeDeleteModal", "type": "Function", - "children": [], + "tags": [], + "label": "closeDeleteModal", + "description": [], "signature": [ "() => void" ], - "description": [], - "label": "closeDeleteModal", "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 196 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.openDeleteModal", "type": "Function", - "children": [], + "tags": [], + "label": "openDeleteModal", + "description": [], "signature": [ "() => void" ], - "description": [], - "label": "openDeleteModal", "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 200 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.setFilter", "type": "Function", + "tags": [], "label": "setFilter", + "description": [], "signature": [ "({ queryText }: { queryText: string; }) => void" ], - "description": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 204 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.setFilter.$1.queryText", "type": "Object", - "label": "{ queryText }", "tags": [], + "label": "{ queryText }", "description": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 204 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.setFilter.$1.queryText.queryText", "type": "string", + "tags": [], "label": "queryText", "description": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 204 - } + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 204 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 204 - } + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.hasNoItems", "type": "Function", + "tags": [], "label": "hasNoItems", + "description": [], "signature": [ "() => boolean" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 215 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.renderConfirmDeleteModal", "type": "Function", + "tags": [], "label": "renderConfirmDeleteModal", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 223 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.renderListingLimitWarning", "type": "Function", + "tags": [], "label": "renderListingLimitWarning", + "description": [], "signature": [ "() => JSX.Element | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 277 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.renderFetchError", "type": "Function", + "tags": [], "label": "renderFetchError", + "description": [], "signature": [ "() => JSX.Element | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 319 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.renderToolsLeft", "type": "Function", + "tags": [], "label": "renderToolsLeft", + "description": [], "signature": [ "() => JSX.Element | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 350 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.renderTable", "type": "Function", + "tags": [], "label": "renderTable", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 381 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.renderListingOrEmptyState", "type": "Function", + "tags": [], "label": "renderListingOrEmptyState", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 461 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.renderListing", "type": "Function", + "tags": [], "label": "renderListing", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 468 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.renderPageContent", "type": "Function", + "tags": [], "label": "renderPageContent", + "description": [], "signature": [ "() => JSX.Element | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 513 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.TableListView.render", "type": "Function", + "tags": [], "label": "render", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 525 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 86 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange", "type": "Class", "tags": [], @@ -422,66 +472,82 @@ }, " extends React.Component" ], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange.defaultProps", "type": "Object", "tags": [], + "label": "defaultProps", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange.defaultProps.allowEmptyRange", "type": "boolean", + "tags": [], "label": "allowEmptyRange", "description": [], + "signature": [ + "true" + ], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 41 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange.defaultProps.fullWidth", "type": "boolean", + "tags": [], "label": "fullWidth", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 42 }, - "signature": [ - "false" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange.defaultProps.compressed", "type": "boolean", + "tags": [], "label": "compressed", "description": [], + "signature": [ + "false" + ], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 43 }, - "signature": [ - "false" - ] + "deprecated": false } - ], - "description": [], - "label": "defaultProps", - "source": { - "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", - "lineNumber": 40 - } + ] }, { + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange.getDerivedStateFromProps", "type": "Function", + "tags": [], "label": "getDerivedStateFromProps", + "description": [], "signature": [ "typeof ", { @@ -493,167 +559,217 @@ }, ".getDerivedStateFromProps" ], - "description": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 46 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange.getDerivedStateFromProps.$1", "type": "Object", + "tags": [], "label": "nextProps", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange.getDerivedStateFromProps.$2", "type": "Object", + "tags": [], "label": "prevState", - "isRequired": true, + "description": [], "signature": [ "State" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 46 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", - "lineNumber": 46 - } + "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange.state", "type": "Object", "tags": [], - "children": [], - "description": [], "label": "state", + "description": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 66 - } + }, + "deprecated": false, + "children": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange._onChange", "type": "Function", + "tags": [], + "label": "_onChange", + "description": [], + "signature": [ + "(value: [React.ReactText, React.ReactText]) => void" + ], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 68 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange._onChange.$1", "type": "Object", + "tags": [], "label": "value", - "isRequired": true, + "description": [], "signature": [ "[React.ReactText, React.ReactText]" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 68 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(value: [React.ReactText, React.ReactText]) => void" - ], - "description": [], - "label": "_onChange", - "source": { - "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", - "lineNumber": 68 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "kibanaReact", "id": "def-public.ValidatedDualRange.render", "type": "Function", + "tags": [], "label": "render", + "description": [], "signature": [ "() => JSX.Element" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 87 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", - "lineNumber": 39 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "kibanaReact", "id": "def-public.CodeEditor", "type": "Function", + "tags": [ + "see" + ], + "label": "CodeEditor", + "description": [ + "\nRenders a Monaco code editor with EUI color theme.\n" + ], + "signature": [ + "(props: React.PropsWithChildren<", + "Props", + ">) => JSX.Element" + ], + "source": { + "path": "src/plugins/kibana_react/public/code_editor/index.tsx", + "lineNumber": 34 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.CodeEditor.$1", "type": "CompoundType", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren<", "Props", ">" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/code_editor/index.tsx", - "lineNumber": 22 - } + "lineNumber": 34 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.CodeEditorField", + "type": "Function", + "tags": [], + "label": "CodeEditorField", + "description": [ + "\nRenders a Monaco code editor in the same style as other EUI form fields." + ], "signature": [ "(props: React.PropsWithChildren<", "Props", ">) => JSX.Element" ], - "description": [], - "label": "CodeEditor", "source": { "path": "src/plugins/kibana_react/public/code_editor/index.tsx", - "lineNumber": 22 + "lineNumber": 48 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.createKibanaReactContext", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.createKibanaReactContext.$1", - "type": "Uncategorized", - "label": "services", - "isRequired": true, + "parentPluginId": "kibanaReact", + "id": "def-public.CodeEditorField.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], "signature": [ - "Services" + "React.PropsWithChildren<", + "Props", + ">" ], - "description": [], "source": { - "path": "src/plugins/kibana_react/public/context/context.tsx", - "lineNumber": 46 - } + "path": "src/plugins/kibana_react/public/code_editor/index.tsx", + "lineNumber": 48 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.createKibanaReactContext", + "type": "Function", + "tags": [], + "label": "createKibanaReactContext", + "description": [], "signature": [ "" ], - "description": [], - "label": "createKibanaReactContext", "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 45 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.createNotifications", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.createNotifications.$1", - "type": "Object", + "parentPluginId": "kibanaReact", + "id": "def-public.createKibanaReactContext.$1", + "type": "Uncategorized", + "tags": [], "label": "services", - "isRequired": true, + "description": [], "signature": [ - "Partial<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - }, - ">" + "Services" ], - "description": [], "source": { - "path": "src/plugins/kibana_react/public/notifications/create_notifications.tsx", - "lineNumber": 14 - } + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 46 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.createNotifications", + "type": "Function", + "tags": [], + "label": "createNotifications", + "description": [], "signature": [ "(services: Partial<", { @@ -728,25 +841,19 @@ "text": "KibanaReactNotifications" } ], - "description": [], - "label": "createNotifications", "source": { "path": "src/plugins/kibana_react/public/notifications/create_notifications.tsx", "lineNumber": 14 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.createReactOverlays", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.createReactOverlays.$1", + "parentPluginId": "kibanaReact", + "id": "def-public.createNotifications.$1", "type": "Object", + "tags": [], "label": "services", - "isRequired": true, + "description": [], "signature": [ "Partial<", { @@ -758,13 +865,24 @@ }, ">" ], - "description": [], "source": { - "path": "src/plugins/kibana_react/public/overlays/create_react_overlays.tsx", + "path": "src/plugins/kibana_react/public/notifications/create_notifications.tsx", "lineNumber": 14 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.createReactOverlays", + "type": "Function", + "tags": [], + "label": "createReactOverlays", + "description": [], "signature": [ "(services: Partial<", { @@ -783,20 +901,48 @@ "text": "KibanaReactOverlays" } ], - "description": [], - "label": "createReactOverlays", "source": { "path": "src/plugins/kibana_react/public/overlays/create_react_overlays.tsx", "lineNumber": 14 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-public.createReactOverlays.$1", + "type": "Object", + "tags": [], + "label": "services", + "description": [], + "signature": [ + "Partial<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ">" + ], + "source": { + "path": "src/plugins/kibana_react/public/overlays/create_react_overlays.tsx", + "lineNumber": 14 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.FieldButton", "type": "Function", + "tags": [], "label": "FieldButton", + "description": [], "signature": [ "({\n size = 'm',\n isActive = false,\n fieldIcon,\n fieldName,\n fieldInfoIcon,\n fieldAction,\n className,\n isDraggable = false,\n onClick,\n dataTestSubj,\n buttonProps,\n ...rest\n}: ", { @@ -808,13 +954,19 @@ }, ") => JSX.Element" ], - "description": [], + "source": { + "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", + "lineNumber": 68 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.FieldButton.$1", "type": "Object", + "tags": [], "label": "{\n size = 'm',\n isActive = false,\n fieldIcon,\n fieldName,\n fieldInfoIcon,\n fieldAction,\n className,\n isDraggable = false,\n onClick,\n dataTestSubj,\n buttonProps,\n ...rest\n}", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaReact", @@ -824,25 +976,26 @@ "text": "FieldButtonProps" } ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", "lineNumber": 68 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", - "lineNumber": 68 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.FieldIcon", "type": "Function", + "tags": [], "label": "FieldIcon", + "description": [ + "\nField token icon used across the app" + ], "signature": [ "({\n type,\n label,\n size = 's',\n scripted,\n className,\n ...rest\n}: ", { @@ -854,15 +1007,19 @@ }, ") => JSX.Element" ], - "description": [ - "\nField token icon used across the app" - ], + "source": { + "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", + "lineNumber": 59 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.FieldIcon.$1", "type": "Object", + "tags": [], "label": "{\n type,\n label,\n size = 's',\n scripted,\n className,\n ...rest\n}", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaReact", @@ -872,279 +1029,336 @@ "text": "FieldIconProps" } ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", "lineNumber": 59 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", - "lineNumber": 59 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.KibanaContextProvider", "type": "Function", - "label": "KibanaContextProvider", "tags": [], + "label": "KibanaContextProvider", "description": [], + "signature": [ + "React.FC<{ services?: {} | undefined; }>" + ], "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 76 }, - "signature": [ - "React.FC<{ services?: {} | undefined; }>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.Markdown", "type": "Function", + "tags": [], + "label": "Markdown", + "description": [], + "signature": [ + "(props: ", + "MarkdownProps", + ") => JSX.Element" + ], + "source": { + "path": "src/plugins/kibana_react/public/markdown/index.tsx", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.Markdown.$1", "type": "Object", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ "MarkdownProps" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/markdown/index.tsx", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(props: ", - "MarkdownProps", - ") => JSX.Element" - ], - "description": [], - "label": "Markdown", - "source": { - "path": "src/plugins/kibana_react/public/markdown/index.tsx", - "lineNumber": 28 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.MarkdownSimple", "type": "Function", + "tags": [], + "label": "MarkdownSimple", + "description": [], + "signature": [ + "(props: ", + "MarkdownSimpleProps", + ") => JSX.Element" + ], + "source": { + "path": "src/plugins/kibana_react/public/markdown/index.tsx", + "lineNumber": 21 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.MarkdownSimple.$1", "type": "Object", + "tags": [], "label": "props", - "isRequired": true, + "description": [], "signature": [ "MarkdownSimpleProps" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/markdown/index.tsx", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(props: ", - "MarkdownSimpleProps", - ") => JSX.Element" - ], - "description": [], - "label": "MarkdownSimple", - "source": { - "path": "src/plugins/kibana_react/public/markdown/index.tsx", - "lineNumber": 21 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.MountPointPortal", "type": "Function", + "tags": [], + "label": "MountPointPortal", + "description": [ + "\nUtility component to portal a part of a react application into the provided `MountPoint`." + ], + "signature": [ + "({ children, setMountPoint }: React.PropsWithChildren) => React.ReactPortal | null" + ], + "source": { + "path": "src/plugins/kibana_react/public/util/mount_point_portal.tsx", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.MountPointPortal.$1", "type": "CompoundType", + "tags": [], "label": "{ children, setMountPoint }", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/util/mount_point_portal.tsx", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ children, setMountPoint }: React.PropsWithChildren) => React.ReactPortal | null" - ], - "description": [ - "\nUtility component to portal a part of a react application into the provided `MountPoint`." - ], - "label": "MountPointPortal", - "source": { - "path": "src/plugins/kibana_react/public/util/mount_point_portal.tsx", - "lineNumber": 22 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.OverviewPageFooter", "type": "Function", + "tags": [], + "label": "OverviewPageFooter", + "description": [], + "signature": [ + "({ addBasePath, path, onSetDefaultRoute, onChangeDefaultRoute, }: React.PropsWithChildren) => JSX.Element" + ], + "source": { + "path": "src/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx", + "lineNumber": 28 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.OverviewPageFooter.$1", "type": "CompoundType", + "tags": [], "label": "{\n addBasePath,\n path,\n onSetDefaultRoute,\n onChangeDefaultRoute,\n}", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ addBasePath, path, onSetDefaultRoute, onChangeDefaultRoute, }: React.PropsWithChildren) => JSX.Element" - ], - "description": [], - "label": "OverviewPageFooter", - "source": { - "path": "src/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx", - "lineNumber": 28 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.OverviewPageHeader", "type": "Function", + "tags": [], + "label": "OverviewPageHeader", + "description": [], + "signature": [ + "({ hideToolbar, iconType, overlap, showDevToolsLink, showManagementLink, title, addBasePath, }: React.PropsWithChildren) => JSX.Element" + ], + "source": { + "path": "src/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx", + "lineNumber": 35 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.OverviewPageHeader.$1", "type": "CompoundType", + "tags": [], "label": "{\n hideToolbar,\n iconType,\n overlap,\n showDevToolsLink,\n showManagementLink,\n title,\n addBasePath,\n}", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ hideToolbar, iconType, overlap, showDevToolsLink, showManagementLink, title, addBasePath, }: React.PropsWithChildren) => JSX.Element" - ], - "description": [], - "label": "OverviewPageHeader", - "source": { - "path": "src/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx", - "lineNumber": 35 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.Panel", "type": "Function", + "tags": [], "label": "Panel", + "description": [], "signature": [ "({ children, className, initialWidth = 100, style = {} }: ", "Props", ") => JSX.Element" ], - "description": [], + "source": { + "path": "src/plugins/kibana_react/public/split_panel/containers/panel.tsx", + "lineNumber": 23 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.Panel.$1", "type": "Object", + "tags": [], "label": "{ children, className, initialWidth = 100, style = {} }", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/split_panel/containers/panel.tsx", "lineNumber": 23 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_react/public/split_panel/containers/panel.tsx", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.PanelsContainer", "type": "Function", + "tags": [], "label": "PanelsContainer", + "description": [], "signature": [ "({\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}: ", "Props", ") => JSX.Element" ], - "description": [], + "source": { + "path": "src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.PanelsContainer.$1", "type": "Object", + "tags": [], "label": "{\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}", - "isRequired": true, + "description": [], "signature": [ "Props" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx", - "lineNumber": 32 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.reactRouterNavigate", "type": "Function", + "tags": [], + "label": "reactRouterNavigate", + "description": [], + "signature": [ + "(history: ", + "History", + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" + }, + ", to: string | LocationObject, onClickCallback?: Function | undefined) => { href: string; onClick: (event: any) => void; }" + ], + "source": { + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.reactRouterNavigate.$1", "type": "CompoundType", + "tags": [], "label": "history", - "isRequired": true, + "description": [], "signature": [ "History", " | ", @@ -1157,41 +1371,58 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaReact", "id": "def-public.reactRouterNavigate.$2", "type": "CompoundType", + "tags": [], "label": "to", - "isRequired": true, + "description": [], "signature": [ "string | LocationObject" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaReact", "id": "def-public.reactRouterNavigate.$3", "type": "Object", + "tags": [], "label": "onClickCallback", - "isRequired": false, + "description": [], "signature": [ "Function | undefined" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": false } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.reactRouterOnClickHandler", + "type": "Function", + "tags": [], + "label": "reactRouterOnClickHandler", + "description": [], "signature": [ "(history: ", "History", @@ -1203,27 +1434,21 @@ "section": "def-public.ScopedHistory", "text": "ScopedHistory" }, - ", to: string | LocationObject, onClickCallback?: Function | undefined) => { href: string; onClick: (event: any) => void; }" + ", to: string | LocationObject, onClickCallback?: Function | undefined) => (event: any) => void" ], - "description": [], - "label": "reactRouterNavigate", "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", - "lineNumber": 26 + "lineNumber": 35 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.reactRouterOnClickHandler", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.reactRouterOnClickHandler.$1", "type": "CompoundType", + "tags": [], "label": "history", - "isRequired": true, + "description": [], "signature": [ "History", " | ", @@ -1236,82 +1461,59 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 36 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaReact", "id": "def-public.reactRouterOnClickHandler.$2", "type": "CompoundType", + "tags": [], "label": "to", - "isRequired": true, + "description": [], "signature": [ "string | LocationObject" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 37 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaReact", "id": "def-public.reactRouterOnClickHandler.$3", "type": "Object", + "tags": [], "label": "onClickCallback", - "isRequired": false, + "description": [], "signature": [ "Function | undefined" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(history: ", - "History", - " | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreApplicationPluginApi", - "section": "def-public.ScopedHistory", - "text": "ScopedHistory" - }, - ", to: string | LocationObject, onClickCallback?: Function | undefined) => (event: any) => void" - ], - "description": [], - "label": "reactRouterOnClickHandler", - "source": { - "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", - "lineNumber": 35 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.reactToUiComponent", "type": "Function", - "children": [ - { - "id": "def-public.reactToUiComponent.$1", - "type": "CompoundType", - "label": "ReactComp", - "isRequired": true, - "signature": [ - "React.ComponentType" - ], - "description": [], - "source": { - "path": "src/plugins/kibana_react/public/adapters/react_to_ui_component.ts", - "lineNumber": 19 - } - } + "tags": [], + "label": "reactToUiComponent", + "description": [ + "\nTransform a React component into a `UiComponent`.\n" ], "signature": [ "(ReactComp: React.ComponentType) => ", @@ -1324,70 +1526,80 @@ }, "" ], - "description": [ - "\nTransform a React component into a `UiComponent`.\n" - ], - "label": "reactToUiComponent", "source": { "path": "src/plugins/kibana_react/public/adapters/react_to_ui_component.ts", "lineNumber": 18 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-public.reactToUiComponent.$1", + "type": "CompoundType", + "tags": [], + "label": "ReactComp", + "description": [], + "signature": [ + "React.ComponentType" + ], + "source": { + "path": "src/plugins/kibana_react/public/adapters/react_to_ui_component.ts", + "lineNumber": 19 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.RedirectAppLinks", "type": "Function", + "tags": [], + "label": "RedirectAppLinks", + "description": [ + "\nUtility component that will intercept click events on children anchor (``) elements to call\n`application.navigateToUrl` with the link's href. This will trigger SPA friendly navigation\nwhen the link points to a valid Kibana app.\n" + ], + "signature": [ + "({ application, children, className, ...otherProps }: React.PropsWithChildren) => JSX.Element" + ], + "source": { + "path": "src/plugins/kibana_react/public/app_links/redirect_app_link.tsx", + "lineNumber": 38 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.RedirectAppLinks.$1", "type": "CompoundType", + "tags": [], "label": "{\n application,\n children,\n className,\n ...otherProps\n}", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/app_links/redirect_app_link.tsx", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ application, children, className, ...otherProps }: React.PropsWithChildren) => JSX.Element" - ], - "description": [ - "\nUtility component that will intercept click events on children anchor (``) elements to call\n`application.navigateToUrl` with the link's href. This will trigger SPA friendly navigation\nwhen the link points to a valid Kibana app.\n" - ], - "label": "RedirectAppLinks", - "source": { - "path": "src/plugins/kibana_react/public/app_links/redirect_app_link.tsx", - "lineNumber": 38 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.toMountPoint", "type": "Function", - "children": [ - { - "id": "def-public.toMountPoint.$1", - "type": "CompoundType", - "label": "node", - "isRequired": false, - "signature": [ - "React.ReactNode" - ], - "description": [], - "source": { - "path": "src/plugins/kibana_react/public/util/to_mount_point.tsx", - "lineNumber": 19 - } - } + "tags": [], + "label": "toMountPoint", + "description": [ + "\nMountPoint converter for react nodes.\n" ], "signature": [ "(node: React.ReactNode) => ", @@ -1400,27 +1612,64 @@ }, "" ], - "description": [ - "\nMountPoint converter for react nodes.\n" - ], - "label": "toMountPoint", "source": { "path": "src/plugins/kibana_react/public/util/to_mount_point.tsx", "lineNumber": 19 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-public.toMountPoint.$1", + "type": "CompoundType", + "tags": [], + "label": "node", + "description": [], + "signature": [ + "React.ReactNode" + ], + "source": { + "path": "src/plugins/kibana_react/public/util/to_mount_point.tsx", + "lineNumber": 19 + }, + "deprecated": false, + "isRequired": false + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.ToolbarButton", "type": "Function", + "tags": [], + "label": "ToolbarButton", + "description": [], + "signature": [ + "({ children, className, fontWeight, size, hasArrow, groupPosition, dataTestSubj, ...rest }: React.PropsWithChildren<", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.ToolbarButtonProps", + "text": "ToolbarButtonProps" + }, + ">) => JSX.Element" + ], + "source": { + "path": "src/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.ToolbarButton.$1", "type": "CompoundType", + "tags": [], "label": "{\n children,\n className,\n fontWeight = 'normal',\n size = 'm',\n hasArrow = true,\n groupPosition = 'none',\n dataTestSubj = '',\n ...rest\n}", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren<", { @@ -1432,43 +1681,50 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ children, className, fontWeight, size, hasArrow, groupPosition, dataTestSubj, ...rest }: React.PropsWithChildren<", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.ToolbarButtonProps", - "text": "ToolbarButtonProps" - }, - ">) => JSX.Element" - ], - "description": [], - "label": "ToolbarButton", - "source": { - "path": "src/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx", - "lineNumber": 49 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.uiToReactComponent", "type": "Function", + "tags": [], + "label": "uiToReactComponent", + "description": [ + "\nTransforms `UiComponent` into a React component." + ], + "signature": [ + "(Comp: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.UiComponent", + "text": "UiComponent" + }, + ", as?: string) => React.FC" + ], + "source": { + "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", + "lineNumber": 15 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.uiToReactComponent.$1", "type": "Function", + "tags": [], "label": "Comp", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -1479,59 +1735,65 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaReact", "id": "def-public.uiToReactComponent.$2", "type": "string", + "tags": [], "label": "as", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", "lineNumber": 17 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(Comp: ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.UiComponent", - "text": "UiComponent" - }, - ", as?: string) => React.FC" - ], - "description": [ - "\nTransforms `UiComponent` into a React component." - ], - "label": "uiToReactComponent", - "source": { - "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", - "lineNumber": 15 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.UrlTemplateEditor", "type": "Function", + "tags": [], + "label": "UrlTemplateEditor", + "description": [], + "signature": [ + "({ height, value, variables, onChange, onEditor, Editor, }: React.PropsWithChildren<", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.UrlTemplateEditorProps", + "text": "UrlTemplateEditorProps" + }, + ">) => JSX.Element" + ], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 40 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.UrlTemplateEditor.$1", "type": "CompoundType", + "tags": [], "label": "{\n height = 105,\n value,\n variables,\n onChange,\n onEditor,\n Editor = CodeEditor,\n}", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren<", { @@ -1543,38 +1805,24 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", "lineNumber": 40 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ height, value, variables, onChange, onEditor, Editor, }: React.PropsWithChildren<", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.UrlTemplateEditorProps", - "text": "UrlTemplateEditorProps" - }, - ">) => JSX.Element" - ], - "description": [], - "label": "UrlTemplateEditor", - "source": { - "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", - "lineNumber": 40 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.useKibana", "type": "Function", - "children": [], + "tags": [], + "label": "useKibana", + "description": [], "signature": [ "() => ", { @@ -1594,25 +1842,46 @@ }, "> & Extra>" ], - "description": [], - "label": "useKibana", "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 24 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.UseKibana", "type": "Function", + "tags": [], + "label": "UseKibana", + "description": [], + "signature": [ + "({ children }: React.PropsWithChildren<{ children: (kibana: ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContextValue", + "text": "KibanaReactContextValue" + }, + ") => React.ReactNode; }>) => JSX.Element" + ], + "source": { + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.UseKibana.$1", "type": "CompoundType", + "tags": [], "label": "{ children }", - "isRequired": true, + "description": [], "signature": [ "React.PropsWithChildren<{ children: (kibana: ", { @@ -1624,149 +1893,136 @@ }, ") => React.ReactNode; }>" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "({ children }: React.PropsWithChildren<{ children: (kibana: ", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.KibanaReactContextValue", - "text": "KibanaReactContextValue" - }, - ") => React.ReactNode; }>) => JSX.Element" - ], - "description": [], - "label": "UseKibana", - "source": { - "path": "src/plugins/kibana_react/public/context/context.tsx", - "lineNumber": 41 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.useUiSetting", "type": "Function", + "tags": [], + "label": "useUiSetting", + "description": [ + "\nReturns the current UI-settings value.\n\nUsage:\n\n```js\nconst darkMode = useUiSetting('theme:darkMode');\n```" + ], + "signature": [ + "(key: string, defaultValue?: T | undefined) => T" + ], + "source": { + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.useUiSetting.$1", "type": "string", + "tags": [], "label": "key", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaReact", "id": "def-public.useUiSetting.$2", "type": "Uncategorized", + "tags": [], "label": "defaultValue", - "isRequired": false, + "description": [], "signature": [ "T | undefined" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(key: string, defaultValue?: T | undefined) => T" - ], - "description": [ - "\nReturns the current UI-settings value.\n\nUsage:\n\n```js\nconst darkMode = useUiSetting('theme:darkMode');\n```" - ], - "label": "useUiSetting", - "source": { - "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", - "lineNumber": 22 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.useUiSetting$", "type": "Function", + "tags": [], + "label": "useUiSetting$", + "description": [ + "\nReturns a 2-tuple, where first entry is the setting value and second is a\nfunction to update the setting value.\n\nSynchronously returns the most current value of the setting and subscribes\nto all subsequent updates, which will re-render your component on new values.\n\nUsage:\n\n```js\nconst [darkMode, setDarkMode] = useUiSetting$('theme:darkMode');\n```" + ], + "signature": [ + "(key: string, defaultValue?: T | undefined) => [T, Setter]" + ], + "source": { + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 47 + }, + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.useUiSetting$.$1", "type": "string", + "tags": [], "label": "key", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "kibanaReact", "id": "def-public.useUiSetting$.$2", "type": "Uncategorized", + "tags": [], "label": "defaultValue", - "isRequired": false, + "description": [], "signature": [ "T | undefined" ], - "description": [], "source": { "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(key: string, defaultValue?: T | undefined) => [T, Setter]" - ], - "description": [ - "\nReturns a 2-tuple, where first entry is the setting value and second is a\nfunction to update the setting value.\n\nSynchronously returns the most current value of the setting and subscribes\nto all subsequent updates, which will re-render your component on new values.\n\nUsage:\n\n```js\nconst [darkMode, setDarkMode] = useUiSetting$('theme:darkMode');\n```" - ], - "label": "useUiSetting$", - "source": { - "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", - "lineNumber": 47 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.withKibana", "type": "Function", - "children": [ - { - "id": "def-public.withKibana.$1", - "type": "CompoundType", - "label": "type", - "isRequired": true, - "signature": [ - "React.ComponentType" - ], - "description": [], - "source": { - "path": "src/plugins/kibana_react/public/context/context.tsx", - "lineNumber": 32 - } - } - ], + "tags": [], + "label": "withKibana", + "description": [], "signature": [ "; }>(type: React.ComponentType) => React.FC>>" ], - "description": [], - "label": "withKibana", "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 31 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-public.withKibana.$1", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "React.ComponentType" + ], + "source": { + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 32 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "kibanaReact", "id": "def-public.ExitFullScreenButtonProps", "type": "Interface", + "tags": [], "label": "ExitFullScreenButtonProps", "description": [], - "tags": [], + "source": { + "path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "kibanaReact", "id": "def-public.ExitFullScreenButtonProps.onExitFullScreenMode", "type": "Function", + "tags": [], "label": "onExitFullScreenMode", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx", "lineNumber": 15 }, - "signature": [ - "() => void" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.FieldButtonProps", "type": "Interface", + "tags": [], "label": "FieldButtonProps", + "description": [], "signature": [ { "pluginId": "kibanaReact", @@ -1832,196 +2112,220 @@ }, " extends React.HTMLAttributes" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "kibanaReact", "id": "def-public.FieldButtonProps.fieldName", "type": "CompoundType", + "tags": [], "label": "fieldName", "description": [ "\nLabel for the button" ], + "signature": [ + "React.ReactNode" + ], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", "lineNumber": 18 }, - "signature": [ - "React.ReactNode" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaReact", "id": "def-public.FieldButtonProps.fieldIcon", "type": "CompoundType", + "tags": [], "label": "fieldIcon", "description": [ "\nIcon representing the field type.\nRecommend using FieldIcon" ], + "signature": [ + "React.ReactNode" + ], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", "lineNumber": 23 }, - "signature": [ - "React.ReactNode" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "kibanaReact", "id": "def-public.FieldButtonProps.fieldInfoIcon", "type": "CompoundType", + "tags": [], "label": "fieldInfoIcon", "description": [ "\nAn optional node to place inside and at the end of the